Class UpdateEntryRequest.Builder (1.71.0) 

public static final class UpdateEntryRequest.Builder extends GeneratedMessageV3.Builder<UpdateEntryRequest.Builder> implements UpdateEntryRequestOrBuilder

Update Entry request.

Protobuf type google.cloud.dataplex.v1.UpdateEntryRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateEntryRequest.Builder

Static Methods

getDescriptor()

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

Methods

addAllAspectKeys(Iterable<String> values)

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

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.

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

Parameter
Name Description
values Iterable<String>

The aspectKeys to add.
Returns
Type Description
UpdateEntryRequest.Builder

This builder for chaining.

addAspectKeys(String value)

public UpdateEntryRequest.Builder addAspectKeys(String value)

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.

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

Parameter
Name Description
value String

The aspectKeys to add.
Returns
Type Description
UpdateEntryRequest.Builder

This builder for chaining.

addAspectKeysBytes(ByteString value)

public UpdateEntryRequest.Builder addAspectKeysBytes(ByteString value)

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.

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
UpdateEntryRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateEntryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateEntryRequest.Builder
Overrides

build()

public UpdateEntryRequest build()
Returns
Type Description
UpdateEntryRequest

buildPartial()

public UpdateEntryRequest buildPartial()
Returns
Type Description
UpdateEntryRequest

clear()

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

clearAllowMissing()

public UpdateEntryRequest.Builder clearAllowMissing()

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

bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateEntryRequest.Builder

This builder for chaining.

clearAspectKeys()

public UpdateEntryRequest.Builder clearAspectKeys()

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.

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

Returns
Type Description
UpdateEntryRequest.Builder

This builder for chaining.

clearDeleteMissingAspects()

public UpdateEntryRequest.Builder clearDeleteMissingAspects()

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.

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

Returns
Type Description
UpdateEntryRequest.Builder

This builder for chaining.

clearEntry()

public UpdateEntryRequest.Builder clearEntry()

Required. Entry resource.

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

Returns
Type Description
UpdateEntryRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public UpdateEntryRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateEntryRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateEntryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateEntryRequest.Builder
Overrides

clearUpdateMask()

public UpdateEntryRequest.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpdateEntryRequest.Builder

clone()

public UpdateEntryRequest.Builder clone()
Returns
Type Description
UpdateEntryRequest.Builder
Overrides

getAllowMissing()

public boolean getAllowMissing()

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

bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The allowMissing.

getAspectKeys(int index)

public String getAspectKeys(int index)

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.

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

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

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

Returns
Type Description
int

The count of aspectKeys.

getAspectKeysList()

public ProtocolStringList getAspectKeysList()

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.

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

Returns
Type Description
ProtocolStringList

A list containing the aspectKeys.

getDefaultInstanceForType()

public UpdateEntryRequest getDefaultInstanceForType()
Returns
Type Description
UpdateEntryRequest

getDeleteMissingAspects()

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

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. Entry resource.

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

Returns
Type Description
Entry

The entry.

getEntryBuilder()

public Entry.Builder getEntryBuilder()

Required. Entry resource.

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

Returns
Type Description
Entry.Builder

getEntryOrBuilder()

public EntryOrBuilder getEntryOrBuilder()

Required. Entry resource.

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

Returns
Type Description
EntryOrBuilder

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 = 2 [(.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 = 2 [(.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasEntry()

public boolean hasEntry()

Required. Entry resource.

.google.cloud.dataplex.v1.Entry entry = 1 [(.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEntry(Entry value)

public UpdateEntryRequest.Builder mergeEntry(Entry value)

Required. Entry resource.

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

Parameter
Name Description
value Entry
Returns
Type Description
UpdateEntryRequest.Builder

mergeFrom(UpdateEntryRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateEntryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateEntryRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateEntryRequest.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateEntryRequest.Builder

setAllowMissing(boolean value)

public UpdateEntryRequest.Builder setAllowMissing(boolean value)

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

bool allow_missing = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The allowMissing to set.
Returns
Type Description
UpdateEntryRequest.Builder

This builder for chaining.

setAspectKeys(int index, String value)

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

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.

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
UpdateEntryRequest.Builder

This builder for chaining.

setDeleteMissingAspects(boolean value)

public UpdateEntryRequest.Builder setDeleteMissingAspects(boolean value)

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.

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

Parameter
Name Description
value boolean

The deleteMissingAspects to set.
Returns
Type Description
UpdateEntryRequest.Builder

This builder for chaining.

setEntry(Entry value)

public UpdateEntryRequest.Builder setEntry(Entry value)

Required. Entry resource.

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

Parameter
Name Description
value Entry
Returns
Type Description
UpdateEntryRequest.Builder

setEntry(Entry.Builder builderForValue)

public UpdateEntryRequest.Builder setEntry(Entry.Builder builderForValue)

Required. Entry resource.

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

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

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateEntryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateEntryRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateEntryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateEntryRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateEntryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateEntryRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateEntryRequest.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateEntryRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateEntryRequest.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 = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateEntryRequest.Builder