Google Cloud Gke Hub V1 Client - Class UpdateMembershipRequest (1.0.0-RC1)

Reference documentation and code samples for the Google Cloud Gke Hub V1 Client class UpdateMembershipRequest.

Request message for GkeHub.UpdateMembership method.

Generated from protobuf message google.cloud.gkehub.v1.UpdateMembershipRequest

Namespace

Google \ Cloud \ GkeHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.
↳ update_mask Google\Protobuf\FieldMask

Required. Mask of fields to update.
↳ resource Google\Cloud\GkeHub\V1\Membership

Required. Only fields specified in update_mask are updated. If you specify a field in the update_mask but don't specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It's not possible to update a key's value to the empty string. If you specify the update_mask to be a special path "*", fully replaces all user-modifiable fields to match resource.
↳ request_id string

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getName

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Returns
Type Description
string

setName

Required. The Membership resource name in the format projects/*/locations/*/memberships/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getUpdateMask

Required. Mask of fields to update.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Mask of fields to update.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getResource

Required. Only fields specified in update_mask are updated.

If you specify a field in the update_mask but don't specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It's not possible to update a key's value to the empty string. If you specify the update_mask to be a special path "*", fully replaces all user-modifiable fields to match resource.

Returns
Type Description
Google\Cloud\GkeHub\V1\Membership|null

hasResource

clearResource

setResource

Required. Only fields specified in update_mask are updated.

If you specify a field in the update_mask but don't specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It's not possible to update a key's value to the empty string. If you specify the update_mask to be a special path "*", fully replaces all user-modifiable fields to match resource.

Parameter
Name Description
var Google\Cloud\GkeHub\V1\Membership
Returns
Type Description
$this

getRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

setRequestId

Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. The Membership resource name in the format projects/*/locations/*/memberships/*. Please see Google\Cloud\GkeHub\V1\GkeHubClient::membershipName() for help formatting this field.
resource Google\Cloud\GkeHub\V1\Membership

Required. Only fields specified in update_mask are updated. If you specify a field in the update_mask but don't specify its value here that field will be deleted. If you are updating a map field, set the value of a key to null or empty string to delete the key from the map. It's not possible to update a key's value to the empty string. If you specify the update_mask to be a special path "*", fully replaces all user-modifiable fields to match resource.
updateMask Google\Protobuf\FieldMask

Required. Mask of fields to update.
Returns
Type Description
Google\Cloud\GkeHub\V1\UpdateMembershipRequest