Reference documentation and code samples for the Google Cloud Api Keys V2 Client class UpdateKeyRequest.
Request message for UpdateKey method.
Generated from protobuf message google.api.apikeys.v2.UpdateKeyRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ key |
Google\Cloud\ApiKeys\V2\Key
Required. Set the |
↳ update_mask |
Google\Protobuf\FieldMask
The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: |
getKey
Required. Set the name field to the resource name of the API key to be
updated. You can update only the display_name, restrictions, and
annotations fields.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ApiKeys\V2\Key|null | |
hasKey
clearKey
setKey
Required. Set the name field to the resource name of the API key to be
updated. You can update only the display_name, restrictions, and
annotations fields.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ApiKeys\V2\Key
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
The field mask specifies which fields to be updated as part of this request. All other fields are ignored.
Mutable fields are: display_name, restrictions, and annotations.
If an update mask is not provided, the service treats it as an implied mask
equivalent to all allowed fields that are set on the wire. If the field
mask has a special value "*", the service treats it equivalent to replace
all allowed mutable fields.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
The field mask specifies which fields to be updated as part of this request. All other fields are ignored.
Mutable fields are: display_name, restrictions, and annotations.
If an update mask is not provided, the service treats it as an implied mask
equivalent to all allowed fields that are set on the wire. If the field
mask has a special value "*", the service treats it equivalent to replace
all allowed mutable fields.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |