AbstractAWSCodePipeline (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codepipeline.AbstractAWSCodePipeline

All Implemented Interfaces:

AWSCodePipeline

Direct Known Subclasses:

AbstractAWSCodePipelineAsync
```
public class AbstractAWSCodePipeline
extends Object
implements AWSCodePipeline
```
Abstract implementation of AWSCodePipeline. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.codepipeline.AWSCodePipeline
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcknowledgeJobResult`	`acknowledgeJob(AcknowledgeJobRequest request)` Returns information about a specified job and whether that job has been received by the job worker.
`AcknowledgeThirdPartyJobResult`	`acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest request)` Confirms a job worker has received the specified job.
`CreateCustomActionTypeResult`	`createCustomActionType(CreateCustomActionTypeRequest request)` Creates a new custom action that can be used in all pipelines associated with the AWS account.
`CreatePipelineResult`	`createPipeline(CreatePipelineRequest request)` Creates a pipeline.
`DeleteCustomActionTypeResult`	`deleteCustomActionType(DeleteCustomActionTypeRequest request)` Marks a custom action as deleted.
`DeletePipelineResult`	`deletePipeline(DeletePipelineRequest request)` Deletes the specified pipeline.
`DisableStageTransitionResult`	`disableStageTransition(DisableStageTransitionRequest request)` Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
`EnableStageTransitionResult`	`enableStageTransition(EnableStageTransitionRequest request)` Enables artifacts in a pipeline to transition to a stage in a pipeline.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetJobDetailsResult`	`getJobDetails(GetJobDetailsRequest request)` Returns information about a job.
`GetPipelineResult`	`getPipeline(GetPipelineRequest request)` Returns the metadata, structure, stages, and actions of a pipeline.
`GetPipelineStateResult`	`getPipelineState(GetPipelineStateRequest request)` Returns information about the state of a pipeline, including the stages and actions.
`GetThirdPartyJobDetailsResult`	`getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest request)` Requests the details of a job for a third party action.
`ListActionTypesResult`	`listActionTypes(ListActionTypesRequest request)` Gets a summary of all AWS CodePipeline action types associated with your account.
`ListPipelinesResult`	`listPipelines(ListPipelinesRequest request)` Gets a summary of all of the pipelines associated with your account.
`PollForJobsResult`	`pollForJobs(PollForJobsRequest request)` Returns information about any jobs for AWS CodePipeline to act upon.
`PollForThirdPartyJobsResult`	`pollForThirdPartyJobs(PollForThirdPartyJobsRequest request)` Determines whether there are any third party jobs for a job worker to act on.
`PutActionRevisionResult`	`putActionRevision(PutActionRevisionRequest request)` Provides information to AWS CodePipeline about new revisions to a source.
`PutApprovalResultResult`	`putApprovalResult(PutApprovalResultRequest request)` Provides the response to a manual approval request to AWS CodePipeline.
`PutJobFailureResultResult`	`putJobFailureResult(PutJobFailureResultRequest request)` Represents the failure of a job as returned to the pipeline by a job worker.
`PutJobSuccessResultResult`	`putJobSuccessResult(PutJobSuccessResultRequest request)` Represents the success of a job as returned to the pipeline by a job worker.
`PutThirdPartyJobFailureResultResult`	`putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest request)` Represents the failure of a third party job as returned to the pipeline by a job worker.
`PutThirdPartyJobSuccessResultResult`	`putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest request)` Represents the success of a third party job as returned to the pipeline by a job worker.
`RetryStageExecutionResult`	`retryStageExecution(RetryStageExecutionRequest request)` Resumes the pipeline execution by retrying the last failed actions in a stage.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://codepipeline.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSCodePipeline.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartPipelineExecutionResult`	`startPipelineExecution(StartPipelineExecutionRequest request)` Starts the specified pipeline.
`UpdatePipelineResult`	`updatePipeline(UpdatePipelineRequest request)` Updates a specified pipeline with edits or changes to its structure.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSCodePipeline
    
    Overrides the default endpoint for this client ("https://codepipeline.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "codepipeline.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://codepipeline.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AWSCodePipeline
    
    Parameters:
    
    endpoint - The endpoint (ex: "codepipeline.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://codepipeline.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSCodePipeline
    
    An alternative to AWSCodePipeline.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AWSCodePipeline
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - acknowledgeJob
```
public AcknowledgeJobResult acknowledgeJob(AcknowledgeJobRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.
    
    Specified by:
    
    acknowledgeJob in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of an acknowledge job action.
    
    Returns:
    
    Result of the AcknowledgeJob operation returned by the service.
  - acknowledgeThirdPartyJob
```
public AcknowledgeThirdPartyJobResult acknowledgeThirdPartyJob(AcknowledgeThirdPartyJobRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Confirms a job worker has received the specified job. Only used for partner actions.
    
    Specified by:
    
    acknowledgeThirdPartyJob in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of an acknowledge third party job action.
    
    Returns:
    
    Result of the AcknowledgeThirdPartyJob operation returned by the service.
  - createCustomActionType
```
public CreateCustomActionTypeResult createCustomActionType(CreateCustomActionTypeRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
    
    Specified by:
    
    createCustomActionType in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a create custom action operation.
    
    Returns:
    
    Result of the CreateCustomActionType operation returned by the service.
  - createPipeline
```
public CreatePipelineResult createPipeline(CreatePipelineRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Creates a pipeline.
    
    Specified by:
    
    createPipeline in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a create pipeline action.
    
    Returns:
    
    Result of the CreatePipeline operation returned by the service.
  - deleteCustomActionType
```
public DeleteCustomActionTypeResult deleteCustomActionType(DeleteCustomActionTypeRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.
    
    You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.
    
    Specified by:
    
    deleteCustomActionType in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a delete custom action operation. The custom action will be marked as deleted.
    
    Returns:
    
    Result of the DeleteCustomActionType operation returned by the service.
  - deletePipeline
```
public DeletePipelineResult deletePipeline(DeletePipelineRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Deletes the specified pipeline.
    
    Specified by:
    
    deletePipeline in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a delete pipeline action.
    
    Returns:
    
    Result of the DeletePipeline operation returned by the service.
  - disableStageTransition
```
public DisableStageTransitionResult disableStageTransition(DisableStageTransitionRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
    
    Specified by:
    
    disableStageTransition in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a disable stage transition input action.
    
    Returns:
    
    Result of the DisableStageTransition operation returned by the service.
  - enableStageTransition
```
public EnableStageTransitionResult enableStageTransition(EnableStageTransitionRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Enables artifacts in a pipeline to transition to a stage in a pipeline.
    
    Specified by:
    
    enableStageTransition in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of an enable stage transition action.
    
    Returns:
    
    Result of the EnableStageTransition operation returned by the service.
  - getJobDetails
```
public GetJobDetailsResult getJobDetails(GetJobDetailsRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Returns information about a job. Only used for custom actions.
    
    When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
    
    Specified by:
    
    getJobDetails in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a get job details action.
    
    Returns:
    
    Result of the GetJobDetails operation returned by the service.
  - getPipeline
```
public GetPipelineResult getPipeline(GetPipelineRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
    
    Specified by:
    
    getPipeline in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a get pipeline action.
    
    Returns:
    
    Result of the GetPipeline operation returned by the service.
  - getPipelineState
```
public GetPipelineStateResult getPipelineState(GetPipelineStateRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Returns information about the state of a pipeline, including the stages and actions.
    
    Specified by:
    
    getPipelineState in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a get pipeline state action.
    
    Returns:
    
    Result of the GetPipelineState operation returned by the service.
  - getThirdPartyJobDetails
```
public GetThirdPartyJobDetailsResult getThirdPartyJobDetails(GetThirdPartyJobDetailsRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Requests the details of a job for a third party action. Only used for partner actions.
    
    When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
    
    Specified by:
    
    getThirdPartyJobDetails in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a get third party job details action.
    
    Returns:
    
    Result of the GetThirdPartyJobDetails operation returned by the service.
  - listActionTypes
```
public ListActionTypesResult listActionTypes(ListActionTypesRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Gets a summary of all AWS CodePipeline action types associated with your account.
    
    Specified by:
    
    listActionTypes in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a list action types action.
    
    Returns:
    
    Result of the ListActionTypes operation returned by the service.
  - listPipelines
```
public ListPipelinesResult listPipelines(ListPipelinesRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Gets a summary of all of the pipelines associated with your account.
    
    Specified by:
    
    listPipelines in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a list pipelines action.
    
    Returns:
    
    Result of the ListPipelines operation returned by the service.
  - pollForJobs
```
public PollForJobsResult pollForJobs(PollForJobsRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Returns information about any jobs for AWS CodePipeline to act upon.
    
    When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.
    
    Specified by:
    
    pollForJobs in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a poll for jobs action.
    
    Returns:
    
    Result of the PollForJobs operation returned by the service.
  - pollForThirdPartyJobs
```
public PollForThirdPartyJobsResult pollForThirdPartyJobs(PollForThirdPartyJobsRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.
    
    When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.
    
    Specified by:
    
    pollForThirdPartyJobs in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a poll for third party jobs action.
    
    Returns:
    
    Result of the PollForThirdPartyJobs operation returned by the service.
  - putActionRevision
```
public PutActionRevisionResult putActionRevision(PutActionRevisionRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Provides information to AWS CodePipeline about new revisions to a source.
    
    Specified by:
    
    putActionRevision in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a put action revision action.
    
    Returns:
    
    Result of the PutActionRevision operation returned by the service.
  - putApprovalResult
```
public PutApprovalResultResult putApprovalResult(PutApprovalResultRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
    
    Specified by:
    
    putApprovalResult in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a put approval result action.
    
    Returns:
    
    Result of the PutApprovalResult operation returned by the service.
  - putJobFailureResult
```
public PutJobFailureResultResult putJobFailureResult(PutJobFailureResultRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.
    
    Specified by:
    
    putJobFailureResult in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a put job failure result action.
    
    Returns:
    
    Result of the PutJobFailureResult operation returned by the service.
  - putJobSuccessResult
```
public PutJobSuccessResultResult putJobSuccessResult(PutJobSuccessResultRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.
    
    Specified by:
    
    putJobSuccessResult in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a put job success result action.
    
    Returns:
    
    Result of the PutJobSuccessResult operation returned by the service.
  - putThirdPartyJobFailureResult
```
public PutThirdPartyJobFailureResultResult putThirdPartyJobFailureResult(PutThirdPartyJobFailureResultRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
    
    Specified by:
    
    putThirdPartyJobFailureResult in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a third party job failure result action.
    
    Returns:
    
    Result of the PutThirdPartyJobFailureResult operation returned by the service.
  - putThirdPartyJobSuccessResult
```
public PutThirdPartyJobSuccessResultResult putThirdPartyJobSuccessResult(PutThirdPartyJobSuccessResultRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.
    
    Specified by:
    
    putThirdPartyJobSuccessResult in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a put third party job success result action.
    
    Returns:
    
    Result of the PutThirdPartyJobSuccessResult operation returned by the service.
  - retryStageExecution
```
public RetryStageExecutionResult retryStageExecution(RetryStageExecutionRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Resumes the pipeline execution by retrying the last failed actions in a stage.
    
    Specified by:
    
    retryStageExecution in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a retry stage execution action.
    
    Returns:
    
    Result of the RetryStageExecution operation returned by the service.
  - startPipelineExecution
```
public StartPipelineExecutionResult startPipelineExecution(StartPipelineExecutionRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
    
    Specified by:
    
    startPipelineExecution in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of a start pipeline execution action.
    
    Returns:
    
    Result of the StartPipelineExecution operation returned by the service.
  - updatePipeline
```
public UpdatePipelineResult updatePipeline(UpdatePipelineRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
    
    Specified by:
    
    updatePipeline in interface AWSCodePipeline
    
    Parameters:
    
    request - Represents the input of an update pipeline action.
    
    Returns:
    
    Result of the UpdatePipeline operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSCodePipeline
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSCodePipeline
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSCodePipeline
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCodePipeline
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSCodePipeline

Field Summary

Fields inherited from interface com.amazonaws.services.codepipeline.AWSCodePipeline

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

acknowledgeJob

acknowledgeThirdPartyJob

createCustomActionType

createPipeline

deleteCustomActionType

deletePipeline

disableStageTransition

enableStageTransition

getJobDetails

getPipeline

getPipelineState

getThirdPartyJobDetails

listActionTypes

listPipelines

pollForJobs

pollForThirdPartyJobs

putActionRevision

putApprovalResult

putJobFailureResult

putJobSuccessResult

putThirdPartyJobFailureResult

putThirdPartyJobSuccessResult

retryStageExecution

startPipelineExecution

updatePipeline

shutdown

getCachedResponseMetadata