Class ModifyEntryRequest.Builder (1.91.0)

public static final class ModifyEntryRequest.Builder extends GeneratedMessage.Builder<ModifyEntryRequest.Builder> implements ModifyEntryRequestOrBuilder

Modify Entry request using permissions in the source system.

Protobuf type google.cloud.dataplex.v1.ModifyEntryRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAspectKeys(Iterable<String> values)

public ModifyEntryRequest.Builder addAllAspectKeys(Iterable<String> values)

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The aspectKeys to add.

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

addAspectKeys(String value)

public ModifyEntryRequest.Builder addAspectKeys(String value)

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The aspectKeys to add.

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

addAspectKeysBytes(ByteString value)

public ModifyEntryRequest.Builder addAspectKeysBytes(ByteString value)

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the aspectKeys to add.

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

build()

public ModifyEntryRequest build()
Returns
Type Description
ModifyEntryRequest

buildPartial()

public ModifyEntryRequest buildPartial()
Returns
Type Description
ModifyEntryRequest

clear()

public ModifyEntryRequest.Builder clear()
Returns
Type Description
ModifyEntryRequest.Builder
Overrides

clearAspectKeys()

public ModifyEntryRequest.Builder clearAspectKeys()

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

clearDeleteMissingAspects()

public ModifyEntryRequest.Builder clearDeleteMissingAspects()

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

bool delete_missing_aspects = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

clearEntry()

public ModifyEntryRequest.Builder clearEntry()

Required. The entry to modify.

.google.cloud.dataplex.v1.Entry entry = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ModifyEntryRequest.Builder

clearName()

public ModifyEntryRequest.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

clearUpdateMask()

public ModifyEntryRequest.Builder clearUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ModifyEntryRequest.Builder

getAspectKeys(int index)

public String getAspectKeys(int index)

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The aspectKeys at the given index.

getAspectKeysBytes(int index)

public ByteString getAspectKeysBytes(int index)

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the aspectKeys at the given index.

getAspectKeysCount()

public int getAspectKeysCount()

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of aspectKeys.

getAspectKeysList()

public ProtocolStringList getAspectKeysList()

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the aspectKeys.

getDefaultInstanceForType()

public ModifyEntryRequest getDefaultInstanceForType()
Returns
Type Description
ModifyEntryRequest

getDeleteMissingAspects()

public boolean getDeleteMissingAspects()

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

bool delete_missing_aspects = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The deleteMissingAspects.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEntry()

public Entry getEntry()

Required. The entry to modify.

.google.cloud.dataplex.v1.Entry entry = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Entry

The entry.

getEntryBuilder()

public Entry.Builder getEntryBuilder()

Required. The entry to modify.

.google.cloud.dataplex.v1.Entry entry = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Entry.Builder

getEntryOrBuilder()

public EntryOrBuilder getEntryOrBuilder()

Required. The entry to modify.

.google.cloud.dataplex.v1.Entry entry = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntryOrBuilder

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getUpdateMask()

public FieldMask 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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasEntry()

public boolean hasEntry()

Required. The entry to modify.

.google.cloud.dataplex.v1.Entry entry = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the entry field is set.

hasUpdateMask()

public boolean hasUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEntry(Entry value)

public ModifyEntryRequest.Builder mergeEntry(Entry value)

Required. The entry to modify.

.google.cloud.dataplex.v1.Entry entry = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Entry
Returns
Type Description
ModifyEntryRequest.Builder

mergeFrom(ModifyEntryRequest other)

public ModifyEntryRequest.Builder mergeFrom(ModifyEntryRequest other)
Parameter
Name Description
other ModifyEntryRequest
Returns
Type Description
ModifyEntryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ModifyEntryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModifyEntryRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ModifyEntryRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ModifyEntryRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public ModifyEntryRequest.Builder mergeUpdateMask(FieldMask value)

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
ModifyEntryRequest.Builder

setAspectKeys(int index, String value)

public ModifyEntryRequest.Builder setAspectKeys(int index, String value)

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.

repeated string aspect_keys = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The aspectKeys to set.

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

setDeleteMissingAspects(boolean value)

public ModifyEntryRequest.Builder setDeleteMissingAspects(boolean value)

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

bool delete_missing_aspects = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The deleteMissingAspects to set.

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

setEntry(Entry value)

public ModifyEntryRequest.Builder setEntry(Entry value)

Required. The entry to modify.

.google.cloud.dataplex.v1.Entry entry = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Entry
Returns
Type Description
ModifyEntryRequest.Builder

setEntry(Entry.Builder builderForValue)

public ModifyEntryRequest.Builder setEntry(Entry.Builder builderForValue)

Required. The entry to modify.

.google.cloud.dataplex.v1.Entry entry = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Entry.Builder
Returns
Type Description
ModifyEntryRequest.Builder

setName(String value)

public ModifyEntryRequest.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ModifyEntryRequest.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ModifyEntryRequest.Builder

This builder for chaining.

setUpdateMask(FieldMask value)

public ModifyEntryRequest.Builder setUpdateMask(FieldMask value)

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
ModifyEntryRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public ModifyEntryRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ModifyEntryRequest.Builder