Google Cloud Dataplex V1 Client - Class UpdateEntryRequest (1.1.0)

Version latest

• 1.1.0 (latest)
• 1.0.1
• 0.16.1
• 0.15.1
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.3
• 0.1.6

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

Update Entry request.

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	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, the service will update all modifiable fields present in the request.
↳ allow_missing	bool Optional. If set to true and the entry doesn't exist, the service will create it.
↳ delete_missing_aspects	bool Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
↳ aspect_keys	array Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: * * <aspect_type_reference> - matches an aspect of the given type and empty path. * * <aspect_type_reference>@path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.<field_name>. * * <aspect_type_reference>* - matches aspects of the given type for all paths. * * *@path - matches aspects of all types on the given path. The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true. If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.

getEntry

Required. Entry resource.

Returns
Type	Description
Entry|null

hasEntry

clearEntry

setEntry

Required. Entry resource.

Parameter
Name	Description
var	Entry

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, the service will update all modifiable fields present in the request.

Returns
Type	Description
Google\Protobuf\FieldMask|null

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, the service will update all modifiable fields present in the request.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getAllowMissing

Optional. If set to true and the entry doesn't exist, the service will create it.

Returns
Type	Description
bool

setAllowMissing

Optional. If set to true and the entry doesn't exist, the service will create it.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getDeleteMissingAspects

Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.

Returns
Type	Description
bool

setDeleteMissingAspects

Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getAspectKeys

Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes:

• <aspect_type_reference> - matches an aspect of the given type and empty path.

• <aspect_type_reference>@path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.<field_name>.

• <aspect_type_reference>* - matches aspects of the given type for all paths.
• *@path - matches aspects of all types on the given path. The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true. If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setAspectKeys

Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes:

• <aspect_type_reference> - matches an aspect of the given type and empty path.

• <aspect_type_reference>@path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.<field_name>.

• <aspect_type_reference>* - matches aspects of the given type for all paths.
• *@path - matches aspects of all types on the given path. The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true. If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

static::build

Parameters
Name	Description
entry	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, the service will update all modifiable fields present in the request.

Returns
Type	Description
UpdateEntryRequest