Reference documentation and code samples for the Google Cloud Apigee Registry V1 Client class UpdateApiRequest.
Request message for UpdateApi.
Generated from protobuf message google.cloud.apigeeregistry.v1.UpdateApiRequest
Namespace
Google \ Cloud \ ApigeeRegistry \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ api |
Google\Cloud\ApigeeRegistry\V1\Api
Required. The API to update. The |
↳ 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 API is not found, a new API will be created. In this situation, |
getApi
Required. The API to update.
The name
field is used to identify the API to update.
Format: projects/*/locations/*/apis/*
Returns | |
---|---|
Type | Description |
Google\Cloud\ApigeeRegistry\V1\Api|null |
hasApi
clearApi
setApi
Required. The API to update.
The name
field is used to identify the API to update.
Format: projects/*/locations/*/apis/*
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\ApigeeRegistry\V1\Api
|
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 API is not found, a new API will be created.
In this situation, update_mask
is ignored.
Returns | |
---|---|
Type | Description |
bool |
setAllowMissing
If set to true, and the API is not found, a new API will be created.
In this situation, update_mask
is ignored.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
api |
Google\Cloud\ApigeeRegistry\V1\Api
Required. The API to update. The |
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\UpdateApiRequest |