Google Cloud Apigee Registry V1 Client - Class UpdateApiDeploymentRequest (0.3.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
NameDescription
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
TypeDescription
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
NameDescription
var Google\Cloud\ApigeeRegistry\V1\ApiDeployment
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
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
TypeDescription
Google\Cloud\ApigeeRegistry\V1\UpdateApiDeploymentRequest