Google Cloud Dataplex V1 Client - Class ModifyEntryRequest (1.14.0)

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

Modify Entry request using permissions in the source system.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.
↳ entry Entry

Required. The entry to modify.
↳ 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.
↳ delete_missing_aspects bool

Optional. If set to true, any aspects not specified in the request will be deleted. The default is false.
↳ aspect_keys string[]

Optional. The aspect keys 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.

getName

Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.

Returns
Type Description
string

setName

Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntry

Required. The entry to modify.

Returns
Type Description
Entry|null

hasEntry

clearEntry

setEntry

Required. The entry to modify.

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

getDeleteMissingAspects

Optional. If set to true, any aspects not specified in the request will be deleted. The default is false.

Returns
Type Description
bool

setDeleteMissingAspects

Optional. If set to true, any aspects not specified in the request will be deleted. The default is false.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAspectKeys

Optional. The aspect keys 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\RepeatedField<string>

setAspectKeys

Optional. The aspect keys 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