Google Cloud Apigee Registry V1 Client - Class UpdateApiVersionRequest (0.3.2)

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

Request message for UpdateApiVersion.

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

Namespace

Google \ Cloud \ ApigeeRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ api_version`	`Google\Cloud\ApigeeRegistry\V1\ApiVersion` Required. The version to update. The `name` field is used to identify the version to update. Format: `projects//locations//apis//versions/`
`↳ 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 version is not found, a new version will be created. In this situation, `update_mask` is ignored.

getApiVersion

Required. The version to update.

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

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

hasApiVersion

clearApiVersion

setApiVersion

Required. The version to update.

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

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

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 version is not found, a new version will be created. In this situation, update_mask is ignored.

Returns
Type	Description
`bool`

setAllowMissing

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters

Name Description

apiVersion

Google\Cloud\ApigeeRegistry\V1\ApiVersion

Required. The version to update.

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

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\UpdateApiVersionRequest`