Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DevopsClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DevopsClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DevopsClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DevopsClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: DevopsWaiter

targetService

targetService: string = "Devops"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://devops.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

approveDeployment

  • Submit stage approval. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ApproveDeployment API.

    Parameters

    Returns Promise<ApproveDeploymentResponse>

    ApproveDeploymentResponse

cancelBuildRun

  • Cancels the build run based on the build run ID provided in the request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelBuildRun API.

    Parameters

    Returns Promise<CancelBuildRunResponse>

    CancelBuildRunResponse

cancelDeployment

  • Cancels a deployment resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CancelDeployment API.

    Parameters

    Returns Promise<CancelDeploymentResponse>

    CancelDeploymentResponse

cancelScheduledCascadingProjectDeletion

changeProjectCompartment

  • Moves a project resource from one compartment OCID to another. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeProjectCompartment API.

    Parameters

    Returns Promise<ChangeProjectCompartmentResponse>

    ChangeProjectCompartmentResponse

close

  • close(): void

createBuildPipeline

  • Creates a new build pipeline.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateBuildPipeline API.

    Parameters

    Returns Promise<CreateBuildPipelineResponse>

    CreateBuildPipelineResponse

createBuildPipelineStage

createBuildRun

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateBuildRun API.

    Parameters

    Returns Promise<CreateBuildRunResponse>

    CreateBuildRunResponse

createConnection

  • Creates a new connection.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateConnection API.

    Parameters

    Returns Promise<CreateConnectionResponse>

    CreateConnectionResponse

createDeployArtifact

  • Creates a new deployment artifact. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDeployArtifact API.

    Parameters

    Returns Promise<CreateDeployArtifactResponse>

    CreateDeployArtifactResponse

createDeployEnvironment

createDeployPipeline

createDeployStage

  • Creates a new deployment stage. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDeployStage API.

    Parameters

    Returns Promise<CreateDeployStageResponse>

    CreateDeployStageResponse

createDeployment

  • Creates a new deployment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDeployment API.

    Parameters

    Returns Promise<CreateDeploymentResponse>

    CreateDeploymentResponse

createProject

  • Creates a new project. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateProject API.

    Parameters

    Returns Promise<CreateProjectResponse>

    CreateProjectResponse

createRepository

  • Creates a new repository.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateRepository API.

    Parameters

    Returns Promise<CreateRepositoryResponse>

    CreateRepositoryResponse

createTrigger

  • Creates a new trigger.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTrigger API.

    Parameters

    Returns Promise<CreateTriggerResponse>

    CreateTriggerResponse

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): DevopsWaiter
  • Creates a new DevopsWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DevopsWaiter

    The service waiters.

deleteBuildPipeline

  • Deletes a build pipeline resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteBuildPipeline API.

    Parameters

    Returns Promise<DeleteBuildPipelineResponse>

    DeleteBuildPipelineResponse

deleteBuildPipelineStage

  • Deletes a stage based on the stage ID provided in the request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteBuildPipelineStage API.

    Parameters

    Returns Promise<DeleteBuildPipelineStageResponse>

    DeleteBuildPipelineStageResponse

deleteConnection

  • Deletes a connection resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteConnection API.

    Parameters

    Returns Promise<DeleteConnectionResponse>

    DeleteConnectionResponse

deleteDeployArtifact

  • Deletes a deployment artifact resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDeployArtifact API.

    Parameters

    Returns Promise<DeleteDeployArtifactResponse>

    DeleteDeployArtifactResponse

deleteDeployEnvironment

  • Deletes a deployment environment resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDeployEnvironment API.

    Parameters

    Returns Promise<DeleteDeployEnvironmentResponse>

    DeleteDeployEnvironmentResponse

deleteDeployPipeline

  • Deletes a deployment pipeline resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDeployPipeline API.

    Parameters

    Returns Promise<DeleteDeployPipelineResponse>

    DeleteDeployPipelineResponse

deleteDeployStage

  • Deletes a deployment stage resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDeployStage API.

    Parameters

    Returns Promise<DeleteDeployStageResponse>

    DeleteDeployStageResponse

deleteProject

  • Deletes a project resource by identifier This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteProject API.

    Parameters

    Returns Promise<DeleteProjectResponse>

    DeleteProjectResponse

deleteRef

  • 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". This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRef API.

    Parameters

    Returns Promise<DeleteRefResponse>

    DeleteRefResponse

deleteRepository

  • Deletes a repository resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRepository API.

    Parameters

    Returns Promise<DeleteRepositoryResponse>

    DeleteRepositoryResponse

deleteTrigger

  • Deletes a trigger resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteTrigger API.

    Parameters

    Returns Promise<DeleteTriggerResponse>

    DeleteTriggerResponse

getBuildPipeline

  • Retrieves a build pipeline by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBuildPipeline API.

    Parameters

    Returns Promise<GetBuildPipelineResponse>

    GetBuildPipelineResponse

getBuildPipelineStage

  • Retrieves a stage based on the stage ID provided in the request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBuildPipelineStage API.

    Parameters

    Returns Promise<GetBuildPipelineStageResponse>

    GetBuildPipelineStageResponse

getBuildRun

  • Returns the details of a build run for a given build run ID.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBuildRun API.

    Parameters

    Returns Promise<GetBuildRunResponse>

    GetBuildRunResponse

getCommit

  • Retrieves a repository's commit by commit ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCommit API.

    Parameters

    Returns Promise<GetCommitResponse>

    GetCommitResponse

getCommitDiff

  • Compares two revisions for their differences. Supports comparison between two references or commits.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCommitDiff API.

    Parameters

    Returns Promise<GetCommitDiffResponse>

    GetCommitDiffResponse

getConnection

  • Retrieves a connection by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConnection API.

    Parameters

    Returns Promise<GetConnectionResponse>

    GetConnectionResponse

getDeployArtifact

  • Retrieves a deployment artifact by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDeployArtifact API.

    Parameters

    Returns Promise<GetDeployArtifactResponse>

    GetDeployArtifactResponse

getDeployEnvironment

  • Retrieves a deployment environment by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDeployEnvironment API.

    Parameters

    Returns Promise<GetDeployEnvironmentResponse>

    GetDeployEnvironmentResponse

getDeployPipeline

  • Retrieves a deployment pipeline by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDeployPipeline API.

    Parameters

    Returns Promise<GetDeployPipelineResponse>

    GetDeployPipelineResponse

getDeployStage

  • Retrieves a deployment stage by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDeployStage API.

    Parameters

    Returns Promise<GetDeployStageResponse>

    GetDeployStageResponse

getDeployment

  • Retrieves a deployment by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDeployment API.

    Parameters

    Returns Promise<GetDeploymentResponse>

    GetDeploymentResponse

getFileDiff

  • 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"

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetFileDiff API.

    Parameters

    Returns Promise<GetFileDiffResponse>

    GetFileDiffResponse

getMirrorRecord

  • Returns either current mirror record or last successful mirror record for a specific mirror repository.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetMirrorRecord API.

    Parameters

    Returns Promise<GetMirrorRecordResponse>

    GetMirrorRecordResponse

getObject

  • Retrieves blob of specific branch name/commit ID and file path.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetObject API.

    Parameters

    Returns Promise<GetObjectResponse>

    GetObjectResponse

getObjectContent

  • Retrieve contents of a specified object.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetObjectContent API.

    Parameters

    Returns Promise<GetObjectContentResponse>

    GetObjectContentResponse

getProject

  • Retrieves a project by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetProject API.

    Parameters

    Returns Promise<GetProjectResponse>

    GetProjectResponse

getRef

  • 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/". This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRef API.

    Parameters

    Returns Promise<GetRefResponse>

    GetRefResponse

getRepoFileDiff

  • Gets the line-by-line difference between file on different commits.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRepoFileDiff API.

    Parameters

    Returns Promise<GetRepoFileDiffResponse>

    GetRepoFileDiffResponse

getRepoFileLines

  • Retrieve lines of a specified file. Supports starting line number and limit.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRepoFileLines API.

    Parameters

    Returns Promise<GetRepoFileLinesResponse>

    GetRepoFileLinesResponse

getRepository

  • Retrieves a repository by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRepository API.

    Parameters

    Returns Promise<GetRepositoryResponse>

    GetRepositoryResponse

getRepositoryArchiveContent

getRepositoryFileLines

  • 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"

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRepositoryFileLines API.

    Parameters

    Returns Promise<GetRepositoryFileLinesResponse>

    GetRepositoryFileLinesResponse

getTrigger

  • Retrieves a trigger by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTrigger API.

    Parameters

    Returns Promise<GetTriggerResponse>

    GetTriggerResponse

getWaiters

getWorkRequest

  • Retrieves the status of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAuthors

  • Retrieve a list of all the authors.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAuthors API.

    Parameters

    Returns Promise<ListAuthorsResponse>

    ListAuthorsResponse

listBuildPipelineStages

  • Returns a list of all stages in a compartment or build pipeline.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBuildPipelineStages API.

    Parameters

    Returns Promise<ListBuildPipelineStagesResponse>

    ListBuildPipelineStagesResponse

listBuildPipelines

  • Returns a list of build pipelines.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBuildPipelines API.

    Parameters

    Returns Promise<ListBuildPipelinesResponse>

    ListBuildPipelinesResponse

listBuildRuns

  • Returns a list of build run summary.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBuildRuns API.

    Parameters

    Returns Promise<ListBuildRunsResponse>

    ListBuildRunsResponse

listCommitDiffs

  • Compares two revisions and lists the differences. Supports comparison between two references or commits.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCommitDiffs API.

    Parameters

    Returns Promise<ListCommitDiffsResponse>

    ListCommitDiffsResponse

listCommits

  • Returns a list of commits.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCommits API.

    Parameters

    Returns Promise<ListCommitsResponse>

    ListCommitsResponse

listConnections

  • Returns a list of connections.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListConnections API.

    Parameters

    Returns Promise<ListConnectionsResponse>

    ListConnectionsResponse

listDeployArtifacts

  • Returns a list of deployment artifacts. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDeployArtifacts API.

    Parameters

    Returns Promise<ListDeployArtifactsResponse>

    ListDeployArtifactsResponse

listDeployEnvironments

listDeployPipelines

  • Returns a list of deployment pipelines. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDeployPipelines API.

    Parameters

    Returns Promise<ListDeployPipelinesResponse>

    ListDeployPipelinesResponse

listDeployStages

  • Retrieves a list of deployment stages. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDeployStages API.

    Parameters

    Returns Promise<ListDeployStagesResponse>

    ListDeployStagesResponse

listDeployments

  • Returns a list of deployments. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDeployments API.

    Parameters

    Returns Promise<ListDeploymentsResponse>

    ListDeploymentsResponse

listMirrorRecords

  • Returns a list of mirror entry in history within 30 days.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListMirrorRecords API.

    Parameters

    Returns Promise<ListMirrorRecordsResponse>

    ListMirrorRecordsResponse

listPaths

  • Retrieves a list of files and directories in a repository.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPaths API.

    Parameters

    Returns Promise<ListPathsResponse>

    ListPathsResponse

listProjects

  • Returns a list of projects. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListProjects API.

    Parameters

    Returns Promise<ListProjectsResponse>

    ListProjectsResponse

listRefs

  • Returns a list of references.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRefs API.

    Parameters

    Returns Promise<ListRefsResponse>

    ListRefsResponse

listRepositories

  • Returns a list of repositories given a compartment ID or a project ID.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRepositories API.

    Parameters

    Returns Promise<ListRepositoriesResponse>

    ListRepositoriesResponse

listTriggers

  • Returns a list of triggers.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTriggers API.

    Parameters

    Returns Promise<ListTriggersResponse>

    ListTriggersResponse

listWorkRequestErrors

  • Returns a list of errors for a given work request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Returns a list of logs for a given work request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the work requests in a compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

mirrorRepository

  • Synchronize a mirrored repository to the latest version from external providers.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use MirrorRepository API.

    Parameters

    Returns Promise<MirrorRepositoryResponse>

    MirrorRepositoryResponse

putRepositoryRef

  • 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".

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PutRepositoryRef API.

    Parameters

    Returns Promise<PutRepositoryRefResponse>

    PutRepositoryRefResponse

scheduleCascadingProjectDeletion

  • Cascading operation that marks Project and child DevOps resources in a DELETING state for a retention period This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ScheduleCascadingProjectDeletion API.

    Parameters

    Returns Promise<ScheduleCascadingProjectDeletionResponse>

    ScheduleCascadingProjectDeletionResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateBuildPipeline

updateBuildPipelineStage

  • Updates the stage based on the stage ID provided in the request. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateBuildPipelineStage API.

    Parameters

    Returns Promise<UpdateBuildPipelineStageResponse>

    UpdateBuildPipelineStageResponse

updateBuildRun

  • Updates the build run. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateBuildRun API.

    Parameters

    Returns Promise<UpdateBuildRunResponse>

    UpdateBuildRunResponse

updateConnection

  • Updates the connection. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateConnection API.

    Parameters

    Returns Promise<UpdateConnectionResponse>

    UpdateConnectionResponse

updateDeployArtifact

updateDeployEnvironment

updateDeployPipeline

updateDeployStage

  • Updates the deployment stage. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDeployStage API.

    Parameters

    Returns Promise<UpdateDeployStageResponse>

    UpdateDeployStageResponse

updateDeployment

  • Updates the deployment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDeployment API.

    Parameters

    Returns Promise<UpdateDeploymentResponse>

    UpdateDeploymentResponse

updateProject

  • Updates the project. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateProject API.

    Parameters

    Returns Promise<UpdateProjectResponse>

    UpdateProjectResponse

updateRepository

  • Updates the repository. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateRepository API.

    Parameters

    Returns Promise<UpdateRepositoryResponse>

    UpdateRepositoryResponse

updateTrigger

  • Updates the trigger. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTrigger API.

    Parameters

    Returns Promise<UpdateTriggerResponse>

    UpdateTriggerResponse

validateConnection

  • Return whether the credentials of the connection are valid.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ValidateConnection API.

    Parameters

    Returns Promise<ValidateConnectionResponse>

    ValidateConnectionResponse