Class DevopsClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.devops.DevopsClient
-
- All Implemented Interfaces:
Devops
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20210630") public class DevopsClient extends BaseSyncClient implements Devops
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DevopsClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for Devops.
-
Constructor Summary
Constructors Constructor Description DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.DevopsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DevopsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DevopsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.devops.Devops
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DevopsClient
@Deprecated public DevopsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDevopsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DevopsClient
@Deprecated public DevopsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDevopsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DevopsClient
@Deprecated public DevopsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDevopsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DevopsClient
@Deprecated public DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDevopsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DevopsClient
@Deprecated public DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDevopsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DevopsClient
@Deprecated public DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDevopsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
DevopsClient
@Deprecated public DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDevopsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
DevopsClient
@Deprecated public DevopsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDevopsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-DevopsClient.Builder.executorService
-
-
Method Detail
-
builder
public static DevopsClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:Devops
Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:Devops
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.
-
approveDeployment
public ApproveDeploymentResponse approveDeployment(ApproveDeploymentRequest request)
Description copied from interface:Devops
Submit stage approval.- Specified by:
approveDeployment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelBuildRun
public CancelBuildRunResponse cancelBuildRun(CancelBuildRunRequest request)
Description copied from interface:Devops
Cancels the build run based on the build run ID provided in the request.- Specified by:
cancelBuildRun
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelDeployment
public CancelDeploymentResponse cancelDeployment(CancelDeploymentRequest request)
Description copied from interface:Devops
Cancels a deployment resource by identifier.- Specified by:
cancelDeployment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
cancelScheduledCascadingProjectDeletion
public CancelScheduledCascadingProjectDeletionResponse cancelScheduledCascadingProjectDeletion(CancelScheduledCascadingProjectDeletionRequest request)
Description copied from interface:Devops
Cascading operation that restores Project and child resources from a DELETING state to an active state- Specified by:
cancelScheduledCascadingProjectDeletion
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeProjectCompartment
public ChangeProjectCompartmentResponse changeProjectCompartment(ChangeProjectCompartmentRequest request)
Description copied from interface:Devops
Moves a project resource from one compartment OCID to another.- Specified by:
changeProjectCompartment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBuildPipeline
public CreateBuildPipelineResponse createBuildPipeline(CreateBuildPipelineRequest request)
Description copied from interface:Devops
Creates a new build pipeline.- Specified by:
createBuildPipeline
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBuildPipelineStage
public CreateBuildPipelineStageResponse createBuildPipelineStage(CreateBuildPipelineStageRequest request)
Description copied from interface:Devops
Creates a new stage.- Specified by:
createBuildPipelineStage
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBuildRun
public CreateBuildRunResponse createBuildRun(CreateBuildRunRequest request)
Description copied from interface:Devops
Starts a build pipeline run for a predefined build pipeline.Please ensure the completion of any work request for creation/updation of Build Pipeline before starting a Build Run.
- Specified by:
createBuildRun
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createConnection
public CreateConnectionResponse createConnection(CreateConnectionRequest request)
Description copied from interface:Devops
Creates a new connection.- Specified by:
createConnection
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDeployArtifact
public CreateDeployArtifactResponse createDeployArtifact(CreateDeployArtifactRequest request)
Description copied from interface:Devops
Creates a new deployment artifact.- Specified by:
createDeployArtifact
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDeployEnvironment
public CreateDeployEnvironmentResponse createDeployEnvironment(CreateDeployEnvironmentRequest request)
Description copied from interface:Devops
Creates a new deployment environment.- Specified by:
createDeployEnvironment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDeployPipeline
public CreateDeployPipelineResponse createDeployPipeline(CreateDeployPipelineRequest request)
Description copied from interface:Devops
Creates a new deployment pipeline.- Specified by:
createDeployPipeline
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDeployStage
public CreateDeployStageResponse createDeployStage(CreateDeployStageRequest request)
Description copied from interface:Devops
Creates a new deployment stage.- Specified by:
createDeployStage
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDeployment
public CreateDeploymentResponse createDeployment(CreateDeploymentRequest request)
Description copied from interface:Devops
Creates a new deployment.- Specified by:
createDeployment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOrUpdateGitRef
public CreateOrUpdateGitRefResponse createOrUpdateGitRef(CreateOrUpdateGitRefRequest request)
Description copied from interface:Devops
Creates a new reference or updates an existing one.- Specified by:
createOrUpdateGitRef
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOrUpdateProtectedBranch
public CreateOrUpdateProtectedBranchResponse createOrUpdateProtectedBranch(CreateOrUpdateProtectedBranchRequest request)
Description copied from interface:Devops
Creates a restriction on a branch that prevents certain actions on it.- Specified by:
createOrUpdateProtectedBranch
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createProject
public CreateProjectResponse createProject(CreateProjectRequest request)
Description copied from interface:Devops
Creates a new project.- Specified by:
createProject
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPullRequest
public CreatePullRequestResponse createPullRequest(CreatePullRequestRequest request)
Description copied from interface:Devops
Creates a new PullRequest.- Specified by:
createPullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPullRequestAttachment
public CreatePullRequestAttachmentResponse createPullRequestAttachment(CreatePullRequestAttachmentRequest request)
Description copied from interface:Devops
Creates PullRequest attachmentNote: This operation consumes a stream.
If the stream supports
InputStream.mark(int)
andInputStream.reset()
, when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream's position was at the time this operation is called}.Note this means that if the caller has used
InputStream.mark(int)
before, then the mark will not be the same anymore after this operation, and a subsequent call toInputStream.reset()
by the caller will reset the stream not to the caller's mark, but to the position the stream was in when this operation was called.If the stream is a
FileInputStream
, and the stream'sFileChannel
position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support forInputStream.mark(int)
andInputStream.reset()
. Then the same procedure as above is followed. If the stream'sFileChannel
position cannot be changed (like for a named pipe), then the stream's contents will be buffered in memory, as described below.If the stream does not support
InputStream.mark(int)
andInputStream.reset()
, then the stream is wrapped in aBufferedInputStream
, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.The contents of the stream, except when the stream is a
FileInputStream
whoseFileChannel
position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.- Specified by:
createPullRequestAttachment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPullRequestComment
public CreatePullRequestCommentResponse createPullRequestComment(CreatePullRequestCommentRequest request)
Description copied from interface:Devops
Creates a new PullRequest comment.- Specified by:
createPullRequestComment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createRepository
public CreateRepositoryResponse createRepository(CreateRepositoryRequest request)
Description copied from interface:Devops
Creates a new repository.- Specified by:
createRepository
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTrigger
public CreateTriggerResponse createTrigger(CreateTriggerRequest request)
Description copied from interface:Devops
Creates a new trigger.- Specified by:
createTrigger
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
declinePullRequest
public DeclinePullRequestResponse declinePullRequest(DeclinePullRequestRequest request)
Description copied from interface:Devops
Decline a PullRequest- Specified by:
declinePullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteBuildPipeline
public DeleteBuildPipelineResponse deleteBuildPipeline(DeleteBuildPipelineRequest request)
Description copied from interface:Devops
Deletes a build pipeline resource by identifier.- Specified by:
deleteBuildPipeline
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteBuildPipelineStage
public DeleteBuildPipelineStageResponse deleteBuildPipelineStage(DeleteBuildPipelineStageRequest request)
Description copied from interface:Devops
Deletes a stage based on the stage ID provided in the request.- Specified by:
deleteBuildPipelineStage
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteConnection
public DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
Description copied from interface:Devops
Deletes a connection resource by identifier.- Specified by:
deleteConnection
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDeployArtifact
public DeleteDeployArtifactResponse deleteDeployArtifact(DeleteDeployArtifactRequest request)
Description copied from interface:Devops
Deletes a deployment artifact resource by identifier.- Specified by:
deleteDeployArtifact
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDeployEnvironment
public DeleteDeployEnvironmentResponse deleteDeployEnvironment(DeleteDeployEnvironmentRequest request)
Description copied from interface:Devops
Deletes a deployment environment resource by identifier.- Specified by:
deleteDeployEnvironment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDeployPipeline
public DeleteDeployPipelineResponse deleteDeployPipeline(DeleteDeployPipelineRequest request)
Description copied from interface:Devops
Deletes a deployment pipeline resource by identifier.- Specified by:
deleteDeployPipeline
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDeployStage
public DeleteDeployStageResponse deleteDeployStage(DeleteDeployStageRequest request)
Description copied from interface:Devops
Deletes a deployment stage resource by identifier.- Specified by:
deleteDeployStage
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteGitRef
public DeleteGitRefResponse deleteGitRef(DeleteGitRefRequest request)
Description copied from interface:Devops
Deletes a Repository’s Ref by its name.Returns an error if the name is ambiguous. Can be disambiguated by using full names like "heads/
" or "tags/ ". - Specified by:
deleteGitRef
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteProject
public DeleteProjectResponse deleteProject(DeleteProjectRequest request)
Description copied from interface:Devops
Deletes a project resource by identifier- Specified by:
deleteProject
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteProjectRepositorySettings
public DeleteProjectRepositorySettingsResponse deleteProjectRepositorySettings(DeleteProjectRepositorySettingsRequest request)
Description copied from interface:Devops
Removes the custom repository settings configured for a project.- Specified by:
deleteProjectRepositorySettings
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteProtectedBranch
public DeleteProtectedBranchResponse deleteProtectedBranch(DeleteProtectedBranchRequest request)
Description copied from interface:Devops
Removes the protection from a branch- Specified by:
deleteProtectedBranch
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePullRequest
public DeletePullRequestResponse deletePullRequest(DeletePullRequestRequest request)
Description copied from interface:Devops
Deletes a PullRequest resource by identifier- Specified by:
deletePullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePullRequestAttachment
public DeletePullRequestAttachmentResponse deletePullRequestAttachment(DeletePullRequestAttachmentRequest request)
Description copied from interface:Devops
Deletes a PullRequest attachment metadata by identifier- Specified by:
deletePullRequestAttachment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePullRequestComment
public DeletePullRequestCommentResponse deletePullRequestComment(DeletePullRequestCommentRequest request)
Description copied from interface:Devops
Deletes a PullRequest comment by identifier- Specified by:
deletePullRequestComment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteRef
public DeleteRefResponse deleteRef(DeleteRefRequest request)
Description copied from interface:Devops
Deletes a Repository’s Ref by its name.Returns an error if the name is ambiguous. Can be disambiguated by using full names like "heads/
" or "tags/ ". This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has ‘/’. This will be replaced by "/repositories/{repositoryId}/actions/deleteGitRef".
-
deleteRepository
public DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest request)
Description copied from interface:Devops
Deletes a repository resource by identifier.- Specified by:
deleteRepository
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteRepositorySettings
public DeleteRepositorySettingsResponse deleteRepositorySettings(DeleteRepositorySettingsRequest request)
Description copied from interface:Devops
Removes the custom settings configured for a repository- Specified by:
deleteRepositorySettings
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTrigger
public DeleteTriggerResponse deleteTrigger(DeleteTriggerRequest request)
Description copied from interface:Devops
Deletes a trigger resource by identifier.- Specified by:
deleteTrigger
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBuildPipeline
public GetBuildPipelineResponse getBuildPipeline(GetBuildPipelineRequest request)
Description copied from interface:Devops
Retrieves a build pipeline by identifier.- Specified by:
getBuildPipeline
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBuildPipelineStage
public GetBuildPipelineStageResponse getBuildPipelineStage(GetBuildPipelineStageRequest request)
Description copied from interface:Devops
Retrieves a stage based on the stage ID provided in the request.- Specified by:
getBuildPipelineStage
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBuildRun
public GetBuildRunResponse getBuildRun(GetBuildRunRequest request)
Description copied from interface:Devops
Returns the details of a build run for a given build run ID.- Specified by:
getBuildRun
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCommit
public GetCommitResponse getCommit(GetCommitRequest request)
Description copied from interface:Devops
Retrieves a repository’s commit by commit ID.
-
getCommitDiff
public GetCommitDiffResponse getCommitDiff(GetCommitDiffRequest request)
Description copied from interface:Devops
Compares two revisions for their differences.Supports comparison between two references or commits.
- Specified by:
getCommitDiff
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConnection
public GetConnectionResponse getConnection(GetConnectionRequest request)
Description copied from interface:Devops
Retrieves a connection by identifier.- Specified by:
getConnection
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDeployArtifact
public GetDeployArtifactResponse getDeployArtifact(GetDeployArtifactRequest request)
Description copied from interface:Devops
Retrieves a deployment artifact by identifier.- Specified by:
getDeployArtifact
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDeployEnvironment
public GetDeployEnvironmentResponse getDeployEnvironment(GetDeployEnvironmentRequest request)
Description copied from interface:Devops
Retrieves a deployment environment by identifier.- Specified by:
getDeployEnvironment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDeployPipeline
public GetDeployPipelineResponse getDeployPipeline(GetDeployPipelineRequest request)
Description copied from interface:Devops
Retrieves a deployment pipeline by identifier.- Specified by:
getDeployPipeline
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDeployStage
public GetDeployStageResponse getDeployStage(GetDeployStageRequest request)
Description copied from interface:Devops
Retrieves a deployment stage by identifier.- Specified by:
getDeployStage
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDeployment
public GetDeploymentResponse getDeployment(GetDeploymentRequest request)
Description copied from interface:Devops
Retrieves a deployment by identifier.- Specified by:
getDeployment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getFileDiff
public GetFileDiffResponse getFileDiff(GetFileDiffRequest request)
Description copied from interface:Devops
Gets the line-by-line difference between file on different commits.This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has ‘/’. This will be replaced by "/repositories/{repositoryId}/file/diffs"
- Specified by:
getFileDiff
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMirrorRecord
public GetMirrorRecordResponse getMirrorRecord(GetMirrorRecordRequest request)
Description copied from interface:Devops
Returns either current mirror record or last successful mirror record for a specific mirror repository.- Specified by:
getMirrorRecord
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getObject
public GetObjectResponse getObject(GetObjectRequest request)
Description copied from interface:Devops
Retrieves blob of specific branch name/commit ID and file path.
-
getObjectContent
public GetObjectContentResponse getObjectContent(GetObjectContentRequest request)
Description copied from interface:Devops
Retrieve contents of a specified object.- Specified by:
getObjectContent
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getProject
public GetProjectResponse getProject(GetProjectRequest request)
Description copied from interface:Devops
Retrieves a project by identifier.- Specified by:
getProject
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getProjectNotificationPreference
public GetProjectNotificationPreferenceResponse getProjectNotificationPreference(GetProjectNotificationPreferenceRequest request)
Description copied from interface:Devops
Get the project notification preference for the user passed as path param- Specified by:
getProjectNotificationPreference
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getProjectRepositorySettings
public GetProjectRepositorySettingsResponse getProjectRepositorySettings(GetProjectRepositorySettingsRequest request)
Description copied from interface:Devops
Retrieves a project’s repository settings details.- Specified by:
getProjectRepositorySettings
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPullRequest
public GetPullRequestResponse getPullRequest(GetPullRequestRequest request)
Description copied from interface:Devops
Gets a PullRequest by identifier- Specified by:
getPullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPullRequestAttachment
public GetPullRequestAttachmentResponse getPullRequestAttachment(GetPullRequestAttachmentRequest request)
Description copied from interface:Devops
Get PullRequest attachment metadata by identifier- Specified by:
getPullRequestAttachment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPullRequestAttachmentContent
public GetPullRequestAttachmentContentResponse getPullRequestAttachmentContent(GetPullRequestAttachmentContentRequest request)
Description copied from interface:Devops
Gets the content of the attachment.- Specified by:
getPullRequestAttachmentContent
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPullRequestChangeSummaryMetrics
public GetPullRequestChangeSummaryMetricsResponse getPullRequestChangeSummaryMetrics(GetPullRequestChangeSummaryMetricsRequest request)
Description copied from interface:Devops
Get pull request diff summary metric- Specified by:
getPullRequestChangeSummaryMetrics
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPullRequestComment
public GetPullRequestCommentResponse getPullRequestComment(GetPullRequestCommentRequest request)
Description copied from interface:Devops
Get PullRequest comment by identifier- Specified by:
getPullRequestComment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPullRequestNotificationPreference
public GetPullRequestNotificationPreferenceResponse getPullRequestNotificationPreference(GetPullRequestNotificationPreferenceRequest request)
Description copied from interface:Devops
Get the pull request notification preference for the user passed as path param- Specified by:
getPullRequestNotificationPreference
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRef
public GetRefResponse getRef(GetRefRequest request)
Description copied from interface:Devops
This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has ‘/’.This will be replaced by "/repositories/{repositoryId}/refs". Retrieves a repository’s reference by its name with preference for branches over tags if the name is ambiguous. This can be disambiguated by using full names like "heads/
" or "tags/ ".
-
getRepoFileDiff
public GetRepoFileDiffResponse getRepoFileDiff(GetRepoFileDiffRequest request)
Description copied from interface:Devops
Gets the line-by-line difference between file on different commits.- Specified by:
getRepoFileDiff
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRepoFileLines
public GetRepoFileLinesResponse getRepoFileLines(GetRepoFileLinesRequest request)
Description copied from interface:Devops
Retrieve lines of a specified file.Supports starting line number and limit.
- Specified by:
getRepoFileLines
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRepository
public GetRepositoryResponse getRepository(GetRepositoryRequest request)
Description copied from interface:Devops
Retrieves a repository by identifier.- Specified by:
getRepository
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRepositoryArchiveContent
public GetRepositoryArchiveContentResponse getRepositoryArchiveContent(GetRepositoryArchiveContentRequest request)
Description copied from interface:Devops
Returns the archived repository information.- Specified by:
getRepositoryArchiveContent
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRepositoryFileLines
public GetRepositoryFileLinesResponse getRepositoryFileLines(GetRepositoryFileLinesRequest request)
Description copied from interface:Devops
Retrieve lines of a specified file.Supports starting line number and limit. This API will be deprecated on Wed, 29 Mar 2023 01:00:00 GMT as it does not get recognized when filePath has ‘/’. This will be replaced by "/repositories/{repositoryId}/file/lines"
- Specified by:
getRepositoryFileLines
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRepositoryNotificationPreference
public GetRepositoryNotificationPreferenceResponse getRepositoryNotificationPreference(GetRepositoryNotificationPreferenceRequest request)
Description copied from interface:Devops
Get the repository notification preference for the user passed as path param- Specified by:
getRepositoryNotificationPreference
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRepositorySettings
public GetRepositorySettingsResponse getRepositorySettings(GetRepositorySettingsRequest request)
Description copied from interface:Devops
Retrieves a repository’s settings details.- Specified by:
getRepositorySettings
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTrigger
public GetTriggerResponse getTrigger(GetTriggerRequest request)
Description copied from interface:Devops
Retrieves a trigger by identifier.- Specified by:
getTrigger
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:Devops
Retrieves the status of the work request with the given ID.- Specified by:
getWorkRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
likePullRequestComment
public LikePullRequestCommentResponse likePullRequestComment(LikePullRequestCommentRequest request)
Description copied from interface:Devops
Like a PullRequest comment- Specified by:
likePullRequestComment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAuthors
public ListAuthorsResponse listAuthors(ListAuthorsRequest request)
Description copied from interface:Devops
Retrieve a list of all the authors.- Specified by:
listAuthors
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBuildPipelineStages
public ListBuildPipelineStagesResponse listBuildPipelineStages(ListBuildPipelineStagesRequest request)
Description copied from interface:Devops
Returns a list of all stages in a compartment or build pipeline.- Specified by:
listBuildPipelineStages
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBuildPipelines
public ListBuildPipelinesResponse listBuildPipelines(ListBuildPipelinesRequest request)
Description copied from interface:Devops
Returns a list of build pipelines.- Specified by:
listBuildPipelines
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBuildRunSnapshots
public ListBuildRunSnapshotsResponse listBuildRunSnapshots(ListBuildRunSnapshotsRequest request)
Description copied from interface:Devops
Returns a list of build run snapshots for a given commit or the latest commit on a pull request if no commit is provided.- Specified by:
listBuildRunSnapshots
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBuildRuns
public ListBuildRunsResponse listBuildRuns(ListBuildRunsRequest request)
Description copied from interface:Devops
Returns a list of build run summary.- Specified by:
listBuildRuns
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCommitDiffs
public ListCommitDiffsResponse listCommitDiffs(ListCommitDiffsRequest request)
Description copied from interface:Devops
Compares two revisions and lists the differences.Supports comparison between two references or commits.
- Specified by:
listCommitDiffs
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCommits
public ListCommitsResponse listCommits(ListCommitsRequest request)
Description copied from interface:Devops
Returns a list of commits.- Specified by:
listCommits
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConnections
public ListConnectionsResponse listConnections(ListConnectionsRequest request)
Description copied from interface:Devops
Returns a list of connections.- Specified by:
listConnections
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDeployArtifacts
public ListDeployArtifactsResponse listDeployArtifacts(ListDeployArtifactsRequest request)
Description copied from interface:Devops
Returns a list of deployment artifacts.- Specified by:
listDeployArtifacts
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDeployEnvironments
public ListDeployEnvironmentsResponse listDeployEnvironments(ListDeployEnvironmentsRequest request)
Description copied from interface:Devops
Returns a list of deployment environments.- Specified by:
listDeployEnvironments
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDeployPipelines
public ListDeployPipelinesResponse listDeployPipelines(ListDeployPipelinesRequest request)
Description copied from interface:Devops
Returns a list of deployment pipelines.- Specified by:
listDeployPipelines
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDeployStages
public ListDeployStagesResponse listDeployStages(ListDeployStagesRequest request)
Description copied from interface:Devops
Retrieves a list of deployment stages.- Specified by:
listDeployStages
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDeployments
public ListDeploymentsResponse listDeployments(ListDeploymentsRequest request)
Description copied from interface:Devops
Returns a list of deployments.- Specified by:
listDeployments
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listForkSyncStatuses
public ListForkSyncStatusesResponse listForkSyncStatuses(ListForkSyncStatusesRequest request)
Description copied from interface:Devops
LIST operation that returns a collection of fork sync status objects.- Specified by:
listForkSyncStatuses
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMirrorRecords
public ListMirrorRecordsResponse listMirrorRecords(ListMirrorRecordsRequest request)
Description copied from interface:Devops
Returns a list of mirror entry in history within 30 days.- Specified by:
listMirrorRecords
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPaths
public ListPathsResponse listPaths(ListPathsRequest request)
Description copied from interface:Devops
Retrieves a list of files and directories in a repository.
-
listProjectCommitAnalyticsAuthors
public ListProjectCommitAnalyticsAuthorsResponse listProjectCommitAnalyticsAuthors(ListProjectCommitAnalyticsAuthorsRequest request)
Description copied from interface:Devops
Retrieve a list of all the Commit Analytics authors.- Specified by:
listProjectCommitAnalyticsAuthors
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProjects
public ListProjectsResponse listProjects(ListProjectsRequest request)
Description copied from interface:Devops
Returns a list of projects.- Specified by:
listProjects
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProtectedBranches
public ListProtectedBranchesResponse listProtectedBranches(ListProtectedBranchesRequest request)
Description copied from interface:Devops
Returns a list of Protected Branches.- Specified by:
listProtectedBranches
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPullRequestActivities
public ListPullRequestActivitiesResponse listPullRequestActivities(ListPullRequestActivitiesRequest request)
Description copied from interface:Devops
List actions that have been taken on a pull request- Specified by:
listPullRequestActivities
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPullRequestAttachments
public ListPullRequestAttachmentsResponse listPullRequestAttachments(ListPullRequestAttachmentsRequest request)
Description copied from interface:Devops
List PullRequest level attachments by identifier- Specified by:
listPullRequestAttachments
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPullRequestAuthors
public ListPullRequestAuthorsResponse listPullRequestAuthors(ListPullRequestAuthorsRequest request)
Description copied from interface:Devops
Retrieve a list of all the PR authors.- Specified by:
listPullRequestAuthors
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPullRequestComments
public ListPullRequestCommentsResponse listPullRequestComments(ListPullRequestCommentsRequest request)
Description copied from interface:Devops
List PullRequest level comments by identifier- Specified by:
listPullRequestComments
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPullRequestCommits
public ListPullRequestCommitsResponse listPullRequestCommits(ListPullRequestCommitsRequest request)
Description copied from interface:Devops
List pull request commits- Specified by:
listPullRequestCommits
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPullRequestFileChanges
public ListPullRequestFileChangesResponse listPullRequestFileChanges(ListPullRequestFileChangesRequest request)
Description copied from interface:Devops
List pull request file changes- Specified by:
listPullRequestFileChanges
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPullRequests
public ListPullRequestsResponse listPullRequests(ListPullRequestsRequest request)
Description copied from interface:Devops
Returns a list of PullRequests.- Specified by:
listPullRequests
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRefs
public ListRefsResponse listRefs(ListRefsRequest request)
Description copied from interface:Devops
Returns a list of references.
-
listRepositories
public ListRepositoriesResponse listRepositories(ListRepositoriesRequest request)
Description copied from interface:Devops
Returns a list of repositories given a compartment ID or a project ID.- Specified by:
listRepositories
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRepositoryCommitAnalyticsAuthors
public ListRepositoryCommitAnalyticsAuthorsResponse listRepositoryCommitAnalyticsAuthors(ListRepositoryCommitAnalyticsAuthorsRequest request)
Description copied from interface:Devops
Retrieve a list of all the Commit Analytics authors.- Specified by:
listRepositoryCommitAnalyticsAuthors
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTriggers
public ListTriggersResponse listTriggers(ListTriggersRequest request)
Description copied from interface:Devops
Returns a list of triggers.- Specified by:
listTriggers
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:Devops
Returns a list of errors for a given work request.- Specified by:
listWorkRequestErrors
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:Devops
Returns a list of logs for a given work request.- Specified by:
listWorkRequestLogs
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:Devops
Lists the work requests in a compartment.- Specified by:
listWorkRequests
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
mergePullRequest
public MergePullRequestResponse mergePullRequest(MergePullRequestRequest request)
Description copied from interface:Devops
Merge the PullRequest- Specified by:
mergePullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
mirrorRepository
public MirrorRepositoryResponse mirrorRepository(MirrorRepositoryRequest request)
Description copied from interface:Devops
Synchronize a mirrored repository to the latest version from external providers.- Specified by:
mirrorRepository
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchPullRequest
public PatchPullRequestResponse patchPullRequest(PatchPullRequestRequest request)
Description copied from interface:Devops
Updates the reviewer list of a pull request- Specified by:
patchPullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
putRepositoryRef
public PutRepositoryRefResponse putRepositoryRef(PutRepositoryRefRequest request)
Description copied from interface:Devops
Creates a new reference or updates an existing one.This API will be deprecated on Wed, 12 June 2024 01:00:00 GMT as it does not get recognized when refName has ‘/’. This will be replaced by "/repositories/{repositoryId}/actions/createOrUpdateGitRef".
- Specified by:
putRepositoryRef
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
reopenPullRequest
public ReopenPullRequestResponse reopenPullRequest(ReopenPullRequestRequest request)
Description copied from interface:Devops
Reopen a PullRequest- Specified by:
reopenPullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
reviewPullRequest
public ReviewPullRequestResponse reviewPullRequest(ReviewPullRequestRequest request)
Description copied from interface:Devops
Review a PullRequest- Specified by:
reviewPullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
scheduleCascadingProjectDeletion
public ScheduleCascadingProjectDeletionResponse scheduleCascadingProjectDeletion(ScheduleCascadingProjectDeletionRequest request)
Description copied from interface:Devops
Cascading operation that marks Project and child DevOps resources in a DELETING state for a retention period- Specified by:
scheduleCascadingProjectDeletion
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
summarizeProjectRepositoryAnalytics
public SummarizeProjectRepositoryAnalyticsResponse summarizeProjectRepositoryAnalytics(SummarizeProjectRepositoryAnalyticsRequest request)
Description copied from interface:Devops
Retrieves repository analytics for a given project.- Specified by:
summarizeProjectRepositoryAnalytics
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
summarizeRepositoryAnalytics
public SummarizeRepositoryAnalyticsResponse summarizeRepositoryAnalytics(SummarizeRepositoryAnalyticsRequest request)
Description copied from interface:Devops
Retrieves repository analytics for a given repository.- Specified by:
summarizeRepositoryAnalytics
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
syncRepository
public SyncRepositoryResponse syncRepository(SyncRepositoryRequest request)
Description copied from interface:Devops
Synchronize a forked repository to the latest version- Specified by:
syncRepository
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
unlikePullRequestComment
public UnlikePullRequestCommentResponse unlikePullRequestComment(UnlikePullRequestCommentRequest request)
Description copied from interface:Devops
Unlike a PullRequest comment- Specified by:
unlikePullRequestComment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
unsubscribePullRequest
public UnsubscribePullRequestResponse unsubscribePullRequest(UnsubscribePullRequestRequest request)
Description copied from interface:Devops
unsubscribe the PullRequest- Specified by:
unsubscribePullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBuildPipeline
public UpdateBuildPipelineResponse updateBuildPipeline(UpdateBuildPipelineRequest request)
Description copied from interface:Devops
Updates the build pipeline.- Specified by:
updateBuildPipeline
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBuildPipelineStage
public UpdateBuildPipelineStageResponse updateBuildPipelineStage(UpdateBuildPipelineStageRequest request)
Description copied from interface:Devops
Updates the stage based on the stage ID provided in the request.- Specified by:
updateBuildPipelineStage
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBuildRun
public UpdateBuildRunResponse updateBuildRun(UpdateBuildRunRequest request)
Description copied from interface:Devops
Updates the build run.- Specified by:
updateBuildRun
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateConnection
public UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
Description copied from interface:Devops
Updates the connection.- Specified by:
updateConnection
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDeployArtifact
public UpdateDeployArtifactResponse updateDeployArtifact(UpdateDeployArtifactRequest request)
Description copied from interface:Devops
Updates the deployment artifact.- Specified by:
updateDeployArtifact
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDeployEnvironment
public UpdateDeployEnvironmentResponse updateDeployEnvironment(UpdateDeployEnvironmentRequest request)
Description copied from interface:Devops
Updates the deployment environment.- Specified by:
updateDeployEnvironment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDeployPipeline
public UpdateDeployPipelineResponse updateDeployPipeline(UpdateDeployPipelineRequest request)
Description copied from interface:Devops
Updates the deployment pipeline.- Specified by:
updateDeployPipeline
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDeployStage
public UpdateDeployStageResponse updateDeployStage(UpdateDeployStageRequest request)
Description copied from interface:Devops
Updates the deployment stage.- Specified by:
updateDeployStage
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDeployment
public UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest request)
Description copied from interface:Devops
Updates the deployment.- Specified by:
updateDeployment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateProject
public UpdateProjectResponse updateProject(UpdateProjectRequest request)
Description copied from interface:Devops
Updates the project.- Specified by:
updateProject
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateProjectNotificationPreference
public UpdateProjectNotificationPreferenceResponse updateProjectNotificationPreference(UpdateProjectNotificationPreferenceRequest request)
Description copied from interface:Devops
Update the project notification preference for the user passed as path param- Specified by:
updateProjectNotificationPreference
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateProjectRepositorySettings
public UpdateProjectRepositorySettingsResponse updateProjectRepositorySettings(UpdateProjectRepositorySettingsRequest request)
Description copied from interface:Devops
Updates the repository settings for a project.- Specified by:
updateProjectRepositorySettings
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePullRequest
public UpdatePullRequestResponse updatePullRequest(UpdatePullRequestRequest request)
Description copied from interface:Devops
Updates the PullRequest- Specified by:
updatePullRequest
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePullRequestComment
public UpdatePullRequestCommentResponse updatePullRequestComment(UpdatePullRequestCommentRequest request)
Description copied from interface:Devops
Updates the PullRequest comment- Specified by:
updatePullRequestComment
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePullRequestNotificationPreference
public UpdatePullRequestNotificationPreferenceResponse updatePullRequestNotificationPreference(UpdatePullRequestNotificationPreferenceRequest request)
Description copied from interface:Devops
Update the pull request notification preference for the user passed as path param- Specified by:
updatePullRequestNotificationPreference
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateRepository
public UpdateRepositoryResponse updateRepository(UpdateRepositoryRequest request)
Description copied from interface:Devops
Updates the repository.- Specified by:
updateRepository
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateRepositoryNotificationPreference
public UpdateRepositoryNotificationPreferenceResponse updateRepositoryNotificationPreference(UpdateRepositoryNotificationPreferenceRequest request)
Description copied from interface:Devops
Update the repository notification preference for the user passed as path param- Specified by:
updateRepositoryNotificationPreference
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateRepositorySettings
public UpdateRepositorySettingsResponse updateRepositorySettings(UpdateRepositorySettingsRequest request)
Description copied from interface:Devops
Updates the settings for a repository.- Specified by:
updateRepositorySettings
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTrigger
public UpdateTriggerResponse updateTrigger(UpdateTriggerRequest request)
Description copied from interface:Devops
Updates the trigger.- Specified by:
updateTrigger
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateConnection
public ValidateConnectionResponse validateConnection(ValidateConnectionRequest request)
Description copied from interface:Devops
Return whether the credentials of the connection are valid.- Specified by:
validateConnection
in interfaceDevops
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DevopsWaiters getWaiters()
Description copied from interface:Devops
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceDevops
- Returns:
- The service waiters.
-
getPaginators
public DevopsPaginators getPaginators()
Description copied from interface:Devops
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginators
in interfaceDevops
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-