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.
Methods
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
buildName
Formats a string containing the fully-qualified path to represent a build resource.
project
string
location
string
build
string
string
clusterName
Formats a string containing the fully-qualified path to represent a cluster resource.
project
string
location
string
cluster
string
string
configName
Formats a string containing the fully-qualified path to represent a config resource.
project
string
location
string
string
deliveryPipelineName
Formats a string containing the fully-qualified path to represent a delivery_pipeline resource.
project
string
location
string
deliveryPipeline
string
string
jobRunName
Formats a string containing the fully-qualified path to represent a job_run resource.
project
string
location
string
deliveryPipeline
string
release
string
rollout
string
jobRun
string
string
locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
membershipName
Formats a string containing the fully-qualified path to represent a membership resource.
project
string
location
string
membership
string
string
releaseName
Formats a string containing the fully-qualified path to represent a release resource.
project
string
location
string
deliveryPipeline
string
release
string
string
rolloutName
Formats a string containing the fully-qualified path to represent a rollout resource.
project
string
location
string
deliveryPipeline
string
release
string
rollout
string
string
serviceName
Formats a string containing the fully-qualified path to represent a service resource.
project
string
location
string
service
string
string
targetName
Formats a string containing the fully-qualified path to represent a target resource.
project
string
location
string
target
string
string
workerPoolName
Formats a string containing the fully-qualified path to represent a worker_pool resource.
project
string
location
string
workerPool
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
__construct
Constructor.
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 false
.
↳ 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 rest
or grpc
. Defaults to grpc
if gRPC support is detected on the system. Advanced usage
: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface
object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
↳ 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.
__call
Handles execution of the async variants for each documented method.
method
mixed
args
mixed
abandonRelease
Abandons a Release in the Delivery Pipeline.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::abandonReleaseAsync() .
request
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.
advanceRollout
Advances a Rollout in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::advanceRolloutAsync() .
request
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.
approveRollout
Approves a Rollout.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::approveRolloutAsync() .
request
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.
cancelRollout
Cancels a Rollout in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::cancelRolloutAsync() .
request
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.
createDeliveryPipeline
Creates a new DeliveryPipeline in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createDeliveryPipelineAsync() .
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.
createRelease
Creates a new Release in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createReleaseAsync() .
request
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.
createRollout
Creates a new Rollout in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createRolloutAsync() .
request
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.
createTarget
Creates a new Target in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::createTargetAsync() .
request
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.
deleteDeliveryPipeline
Deletes a single DeliveryPipeline.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::deleteDeliveryPipelineAsync() .
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.
deleteTarget
Deletes a single Target.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::deleteTargetAsync() .
request
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.
getConfig
Gets the configuration for a location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getConfigAsync() .
request
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.
getDeliveryPipeline
Gets details of a single DeliveryPipeline.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getDeliveryPipelineAsync() .
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.
getJobRun
Gets details of a single JobRun.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getJobRunAsync() .
request
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.
getRelease
Gets details of a single Release.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getReleaseAsync() .
request
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.
getRollout
Gets details of a single Rollout.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getRolloutAsync() .
request
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.
getTarget
Gets details of a single Target.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getTargetAsync() .
request
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.
ignoreJob
Ignores the specified Job in a Rollout.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::ignoreJobAsync() .
request
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.
listDeliveryPipelines
Lists DeliveryPipelines in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listDeliveryPipelinesAsync() .
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.
listJobRuns
Lists JobRuns in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listJobRunsAsync() .
request
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.
listReleases
Lists Releases in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listReleasesAsync() .
request
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.
listRollouts
Lists Rollouts in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listRolloutsAsync() .
request
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.
listTargets
Lists Targets in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listTargetsAsync() .
request
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.
retryJob
Retries the specified Job in a Rollout.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::retryJobAsync() .
request
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.
terminateJobRun
Terminates a Job Run in a given project and location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::terminateJobRunAsync() .
request
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.
updateDeliveryPipeline
Updates the parameters of a single DeliveryPipeline.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::updateDeliveryPipelineAsync() .
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.
updateTarget
Updates the parameters of a single Target.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::updateTargetAsync() .
request
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::getLocationAsync() .
request
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Deploy\V1\Client\BaseClient\self::listLocationsAsync() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
