Reference documentation and code samples for the Google Cloud Api Gateway V1 Client class UpdateApiRequest.
Request message for ApiGatewayService.UpdateApi
Generated from protobuf message google.cloud.apigateway.v1.UpdateApiRequest
Namespace
Google \ Cloud \ ApiGateway \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ update_mask |
Google\Protobuf\FieldMask
Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
↳ api |
Google\Cloud\ApiGateway\V1\Api
Required. API resource. |
getUpdateMask
Field mask is used to specify the fields to be overwritten in the Api resource by the update.
The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
Field mask is used to specify the fields to be overwritten in the Api resource by the update.
The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApi
Required. API resource.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ApiGateway\V1\Api|null | |
hasApi
clearApi
setApi
Required. API resource.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ApiGateway\V1\Api
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
api |
Google\Cloud\ApiGateway\V1\Api
Required. API resource. |
updateMask |
Google\Protobuf\FieldMask
Field mask is used to specify the fields to be overwritten in the Api resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ApiGateway\V1\UpdateApiRequest | |