Google Cloud Dataplex V1 Client - Class UpdateEntryRequest (1.0.1)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class UpdateEntryRequest.

Generated from protobuf message google.cloud.dataplex.v1.UpdateEntryRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ entry
Google\Cloud\Dataplex\V1\Entry

Required. Entry resource.

↳ update_mask
Google\Protobuf\FieldMask

Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects". If the update_mask is empty, all modifiable fields present in the request will be updated.

↳ allow_missing
bool

Optional. If set to true and the entry does not exist, it will be created.

↳ delete_missing_aspects
bool

Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted.

↳ aspect_keys
array

Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes: * * <aspect_type_reference> - matches aspect on given type and empty path * * <aspect_type_reference>@path - matches aspect on given type and specified path * * <aspect_type_reference>* - matches aspects on given type for all paths * * *@path - matches aspects of all types on the given path Existing aspects matching the syntax will not be removed unless delete_missing_aspects is set to true. If this field is left empty, it will be treated as specifying exactly those Aspects present in the request.

getEntry

Required. Entry resource.

Returns
Type
Description

hasEntry

clearEntry

setEntry

Required. Entry resource.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateMask

Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".

If the update_mask is empty, all modifiable fields present in the request will be updated.

Returns
Type
Description

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".

If the update_mask is empty, all modifiable fields present in the request will be updated.

Parameter
Name
Description
Returns
Type
Description
$this

getAllowMissing

Optional. If set to true and the entry does not exist, it will be created.

Returns
Type
Description
bool

setAllowMissing

Optional. If set to true and the entry does not exist, it will be created.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getDeleteMissingAspects

Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted.

Returns
Type
Description
bool

setDeleteMissingAspects

Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getAspectKeys

Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes:

  • <aspect_type_reference> - matches aspect on given type and empty path
  • <aspect_type_reference>@path - matches aspect on given type and specified path
  • <aspect_type_reference>* - matches aspects on given type for all paths
  • *@path - matches aspects of all types on the given path Existing aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.

If this field is left empty, it will be treated as specifying exactly those Aspects present in the request.

Returns
Type
Description

setAspectKeys

Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes:

  • <aspect_type_reference> - matches aspect on given type and empty path
  • <aspect_type_reference>@path - matches aspect on given type and specified path
  • <aspect_type_reference>* - matches aspects on given type for all paths
  • *@path - matches aspects of all types on the given path Existing aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.

If this field is left empty, it will be treated as specifying exactly those Aspects present in the request.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

static::build

Parameters
Name
Description
entry
Google\Cloud\Dataplex\V1\Entry

Required. Entry resource.

updateMask
Google\Protobuf\FieldMask

Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".

If the update_mask is empty, all modifiable fields present in the request will be updated.

Design a Mobile Site
View Site in Mobile | Classic
Share by: