Class UpdateTagTemplateFieldRequest (1.40.0)

public final class UpdateTagTemplateFieldRequest extends GeneratedMessageV3 implements UpdateTagTemplateFieldRequestOrBuilder

Request message for UpdateTagTemplateField.

Protobuf type google.cloud.datacatalog.v1beta1.UpdateTagTemplateFieldRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TAG_TEMPLATE_FIELD_FIELD_NUMBER

public static final int TAG_TEMPLATE_FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UpdateTagTemplateFieldRequest getDefaultInstance()
Returns
TypeDescription
UpdateTagTemplateFieldRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UpdateTagTemplateFieldRequest.Builder newBuilder()
Returns
TypeDescription
UpdateTagTemplateFieldRequest.Builder

newBuilder(UpdateTagTemplateFieldRequest prototype)

public static UpdateTagTemplateFieldRequest.Builder newBuilder(UpdateTagTemplateFieldRequest prototype)
Parameter
NameDescription
prototypeUpdateTagTemplateFieldRequest
Returns
TypeDescription
UpdateTagTemplateFieldRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateTagTemplateFieldRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateTagTemplateFieldRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UpdateTagTemplateFieldRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateTagTemplateFieldRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateTagTemplateFieldRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateTagTemplateFieldRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateTagTemplateFieldRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateTagTemplateFieldRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UpdateTagTemplateFieldRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateTagTemplateFieldRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UpdateTagTemplateFieldRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateTagTemplateFieldRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateTagTemplateFieldRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UpdateTagTemplateFieldRequest> parser()
Returns
TypeDescription
Parser<UpdateTagTemplateFieldRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UpdateTagTemplateFieldRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateTagTemplateFieldRequest

getName()

public String getName()

Required. The name of the tag template field. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the tag template field. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}/fields/{tag_template_field_id}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<UpdateTagTemplateFieldRequest> getParserForType()
Returns
TypeDescription
Parser<UpdateTagTemplateFieldRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTagTemplateField()

public TagTemplateField getTagTemplateField()

Required. The template to update.

.google.cloud.datacatalog.v1beta1.TagTemplateField tag_template_field = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TagTemplateField

The tagTemplateField.

getTagTemplateFieldOrBuilder()

public TagTemplateFieldOrBuilder getTagTemplateFieldOrBuilder()

Required. The template to update.

.google.cloud.datacatalog.v1beta1.TagTemplateField tag_template_field = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TagTemplateFieldOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:

  • display_name
  • type.enum_type
  • is_required

    If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.

    Additionally, updating a template field from optional to required is not allowed.

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

Returns
TypeDescription
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:

  • display_name
  • type.enum_type
  • is_required

    If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.

    Additionally, updating a template field from optional to required is not allowed.

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

Returns
TypeDescription
FieldMaskOrBuilder

hasTagTemplateField()

public boolean hasTagTemplateField()

Required. The template to update.

.google.cloud.datacatalog.v1beta1.TagTemplateField tag_template_field = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the tagTemplateField field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Optional. Names of fields whose values to overwrite on an individual field of a tag template. The following fields are modifiable:

  • display_name
  • type.enum_type
  • is_required

    If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied with one exception: when updating an enum type, the provided values are merged with the existing values. Therefore, enum values can only be added, existing enum values cannot be deleted or renamed.

    Additionally, updating a template field from optional to required is not allowed.

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

Returns
TypeDescription
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UpdateTagTemplateFieldRequest.Builder newBuilderForType()
Returns
TypeDescription
UpdateTagTemplateFieldRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateTagTemplateFieldRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UpdateTagTemplateFieldRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UpdateTagTemplateFieldRequest.Builder toBuilder()
Returns
TypeDescription
UpdateTagTemplateFieldRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException