Google Cloud Dataproc Metastore V1 Client - Class UpdateFederationRequest (1.0.1)

Reference documentation and code samples for the Google Cloud Dataproc Metastore V1 Client class UpdateFederationRequest.

Request message for UpdateFederation.

Generated from protobuf message google.cloud.metastore.v1.UpdateFederationRequest

Namespace

Google \ Cloud \ Metastore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ update_mask Google\Protobuf\FieldMask

Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.
↳ federation Federation

Required. The metastore federation to update. The server only merges fields in the service if they are specified in update_mask. The metastore federation's name field is used to identify the metastore service to be updated.
↳ request_id string

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

getUpdateMask

Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update.

Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update.

Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

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

getFederation

Required. The metastore federation to update. The server only merges fields in the service if they are specified in update_mask.

The metastore federation's name field is used to identify the metastore service to be updated.

Returns
Type Description
Federation|null

hasFederation

clearFederation

setFederation

Required. The metastore federation to update. The server only merges fields in the service if they are specified in update_mask.

The metastore federation's name field is used to identify the metastore service to be updated.

Parameter
Name Description
var Federation
Returns
Type Description
$this

getRequestId

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.

For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Returns
Type Description
string

setRequestId

Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.

For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid UUID A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
federation Federation

Required. The metastore federation to update. The server only merges fields in the service if they are specified in update_mask.

The metastore federation's name field is used to identify the metastore service to be updated.
updateMask Google\Protobuf\FieldMask

Required. A field mask used to specify the fields to be overwritten in the metastore federation resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.
Returns
Type Description
UpdateFederationRequest