Google Cloud Apigee Registry V1 Client - Class UpdateApiDeploymentRequest (0.4.2)

Reference documentation and code samples for the Google Cloud Apigee Registry V1 Client class UpdateApiDeploymentRequest.

Request message for UpdateApiDeployment.

Generated from protobuf message google.cloud.apigeeregistry.v1.UpdateApiDeploymentRequest

Namespace

Google \ Cloud \ ApigeeRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ api_deployment`	`Google\Cloud\ApigeeRegistry\V1\ApiDeployment` Required. The deployment to update. The `name` field is used to identify the deployment to update. Format: `projects//locations//apis//deployments/`
`↳ update_mask`	`Google\Protobuf\FieldMask` The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.
`↳ allow_missing`	`bool` If set to true, and the deployment is not found, a new deployment will be created. In this situation, `update_mask` is ignored.

getApiDeployment

Required. The deployment to update.

The name field is used to identify the deployment to update. Format: projects/*/locations/*/apis/*/deployments/*

Returns
Type	Description
`Google\Cloud\ApigeeRegistry\V1\ApiDeployment\|null`

hasApiDeployment

clearApiDeployment

setApiDeployment

Required. The deployment to update.

The name field is used to identify the deployment to update. Format: projects/*/locations/*/apis/*/deployments/*

Parameter
Name	Description
`var`	`Google\Cloud\ApigeeRegistry\V1\ApiDeployment`

Returns
Type	Description
`$this`

getUpdateMask

The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored).

If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored).

If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getAllowMissing

If set to true, and the deployment is not found, a new deployment will be created. In this situation, update_mask is ignored.

Returns
Type	Description
`bool`

setAllowMissing

If set to true, and the deployment is not found, a new deployment will be created. In this situation, update_mask is ignored.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters

Name Description

apiDeployment

Google\Cloud\ApigeeRegistry\V1\ApiDeployment

Required. The deployment to update.

The name field is used to identify the deployment to update. Format: projects/*/locations/*/apis/*/deployments/*

updateMask

Google\Protobuf\FieldMask

The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

Returns
Type	Description
`Google\Cloud\ApigeeRegistry\V1\UpdateApiDeploymentRequest`