Reference documentation and code samples for the Google Cloud Deploy V1 Client class CloudDeployClient.
Service Description: CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Deploy \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
abandonRelease
Abandons a Release in the Delivery Pipeline.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::abandonReleaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\AbandonReleaseRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\AbandonReleaseResponse |
advanceRollout
Advances a Rollout in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::advanceRolloutAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\AdvanceRolloutRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\AdvanceRolloutResponse |
approveRollout
Approves a Rollout.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::approveRolloutAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ApproveRolloutRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\ApproveRolloutResponse |
cancelRollout
Cancels a Rollout in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::cancelRolloutAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CancelRolloutRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\CancelRolloutResponse |
createDeliveryPipeline
Creates a new DeliveryPipeline in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createDeliveryPipelineAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CreateDeliveryPipelineRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
createRelease
Creates a new Release in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createReleaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CreateReleaseRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
createRollout
Creates a new Rollout in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createRolloutAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CreateRolloutRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
createTarget
Creates a new Target in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createTargetAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CreateTargetRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
deleteDeliveryPipeline
Deletes a single DeliveryPipeline.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::deleteDeliveryPipelineAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\DeleteDeliveryPipelineRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
deleteTarget
Deletes a single Target.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::deleteTargetAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\DeleteTargetRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
getConfig
Gets the configuration for a location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getConfigAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetConfigRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\Config |
getDeliveryPipeline
Gets details of a single DeliveryPipeline.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getDeliveryPipelineAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetDeliveryPipelineRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\DeliveryPipeline |
getJobRun
Gets details of a single JobRun.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getJobRunAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetJobRunRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\JobRun |
getRelease
Gets details of a single Release.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getReleaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetReleaseRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\Release |
getRollout
Gets details of a single Rollout.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getRolloutAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetRolloutRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\Rollout |
getTarget
Gets details of a single Target.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getTargetAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetTargetRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\Target |
ignoreJob
Ignores the specified Job in a Rollout.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::ignoreJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\IgnoreJobRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\IgnoreJobResponse |
listDeliveryPipelines
Lists DeliveryPipelines in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listDeliveryPipelinesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListDeliveryPipelinesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listJobRuns
Lists JobRuns in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listJobRunsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListJobRunsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listReleases
Lists Releases in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listReleasesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListReleasesRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listRollouts
Lists Rollouts in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listRolloutsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListRolloutsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listTargets
Lists Targets in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listTargetsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListTargetsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
retryJob
Retries the specified Job in a Rollout.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::retryJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\RetryJobRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\RetryJobResponse |
terminateJobRun
Terminates a Job Run in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::terminateJobRunAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\TerminateJobRunRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\TerminateJobRunResponse |
updateDeliveryPipeline
Updates the parameters of a single DeliveryPipeline.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::updateDeliveryPipelineAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\UpdateDeliveryPipelineRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
updateTarget
Updates the parameters of a single Target.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::updateTargetAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\UpdateTargetRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
getLocation
Gets information about a location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getLocationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Location\Location |
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listLocationsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
abandonReleaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\AbandonReleaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
advanceRolloutAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\AdvanceRolloutRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
approveRolloutAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ApproveRolloutRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
cancelRolloutAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CancelRolloutRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createDeliveryPipelineAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CreateDeliveryPipelineRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createReleaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CreateReleaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createRolloutAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CreateRolloutRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createTargetAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\CreateTargetRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteDeliveryPipelineAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\DeleteDeliveryPipelineRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteTargetAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\DeleteTargetRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getDeliveryPipelineAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetDeliveryPipelineRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getJobRunAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetJobRunRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getReleaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetReleaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getRolloutAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetRolloutRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getTargetAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\GetTargetRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
ignoreJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\IgnoreJobRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listDeliveryPipelinesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListDeliveryPipelinesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listJobRunsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListJobRunsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listReleasesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListReleasesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listRolloutsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListRolloutsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listTargetsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\ListTargetsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
retryJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\RetryJobRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
terminateJobRunAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\TerminateJobRunRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateDeliveryPipelineAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\UpdateDeliveryPipelineRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateTargetAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Deploy\V1\UpdateTargetRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::buildName
Formats a string containing the fully-qualified path to represent a build resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
build |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted build resource. |
static::clusterName
Formats a string containing the fully-qualified path to represent a cluster resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
cluster |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted cluster resource. |
static::configName
Formats a string containing the fully-qualified path to represent a config resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted config resource. |
static::deliveryPipelineName
Formats a string containing the fully-qualified path to represent a delivery_pipeline resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
deliveryPipeline |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted delivery_pipeline resource. |
static::jobRunName
Formats a string containing the fully-qualified path to represent a job_run resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
deliveryPipeline |
string
|
release |
string
|
rollout |
string
|
jobRun |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted job_run resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted location resource. |
static::membershipName
Formats a string containing the fully-qualified path to represent a membership resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
membership |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted membership resource. |
static::releaseName
Formats a string containing the fully-qualified path to represent a release resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
deliveryPipeline |
string
|
release |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted release resource. |
static::rolloutName
Formats a string containing the fully-qualified path to represent a rollout resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
deliveryPipeline |
string
|
release |
string
|
rollout |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted rollout resource. |
static::serviceName
Formats a string containing the fully-qualified path to represent a service resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
service |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted service resource. |
static::targetName
Formats a string containing the fully-qualified path to represent a target resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
target |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted target resource. |
static::workerPoolName
Formats a string containing the fully-qualified path to represent a worker_pool resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
workerPool |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted worker_pool resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- build: projects/{project}/locations/{location}/builds/{build}
- cluster: projects/{project}/locations/{location}/clusters/{cluster}
- config: projects/{project}/locations/{location}/config
- deliveryPipeline: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}
- jobRun: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{job_run}
- location: projects/{project}/locations/{location}
- membership: projects/{project}/locations/{location}/memberships/{membership}
- release: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}
- rollout: projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}
- service: projects/{project}/locations/{location}/services/{service}
- target: projects/{project}/locations/{location}/targets/{target}
- workerPool: projects/{project}/locations/{location}/workerPools/{worker_pool}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |