Class Field (0.1.0)

public final class Field extends GeneratedMessageV3 implements FieldOrBuilder

A field in a schema.

Protobuf type google.cloud.geminidataanalytics.v1beta.Field

Implements

FieldOrBuilder

Static Fields

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SUBFIELDS_FIELD_NUMBER

public static final int SUBFIELDS_FIELD_NUMBER
Field Value
Type Description
int

SYNONYMS_FIELD_NUMBER

public static final int SYNONYMS_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FORMAT_FIELD_NUMBER

public static final int VALUE_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Field getDefaultInstance()
Returns
Type Description
Field

getDescriptor()

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

newBuilder()

public static Field.Builder newBuilder()
Returns
Type Description
Field.Builder

newBuilder(Field prototype)

public static Field.Builder newBuilder(Field prototype)
Parameter
Name Description
prototype Field
Returns
Type Description
Field.Builder

parseDelimitedFrom(InputStream input)

public static Field parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Field parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Field parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Field parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Field parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Field parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Field parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Field> parser()
Returns
Type Description
Parser<Field>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCategory()

public String getCategory()

Optional. Field category, not required, currently only useful for Looker. We are using a string to avoid depending on an external package and keep this package self-contained.

string category = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The category.

getCategoryBytes()

public ByteString getCategoryBytes()

Optional. Field category, not required, currently only useful for Looker. We are using a string to avoid depending on an external package and keep this package self-contained.

string category = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for category.

getDefaultInstanceForType()

public Field getDefaultInstanceForType()
Returns
Type Description
Field

getDescription()

public String getDescription()

Optional. A brief description of the field.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A brief description of the field.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Optional. Field display_name (same as label in

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Field display_name (same as label in

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getMode()

public String getMode()

Optional. The mode of the field (e.g., NULLABLE, REPEATED).

string mode = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The mode.

getModeBytes()

public ByteString getModeBytes()

Optional. The mode of the field (e.g., NULLABLE, REPEATED).

string mode = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for mode.

getName()

public String getName()

Optional. The name of the field.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. The name of the field.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Field> getParserForType()
Returns
Type Description
Parser<Field>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubfields(int index)

public Field getSubfields(int index)

Optional. Recursive property for nested schema structures.

repeated .google.cloud.geminidataanalytics.v1beta.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Field

getSubfieldsCount()

public int getSubfieldsCount()

Optional. Recursive property for nested schema structures.

repeated .google.cloud.geminidataanalytics.v1beta.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSubfieldsList()

public List<Field> getSubfieldsList()

Optional. Recursive property for nested schema structures.

repeated .google.cloud.geminidataanalytics.v1beta.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Field>

getSubfieldsOrBuilder(int index)

public FieldOrBuilder getSubfieldsOrBuilder(int index)

Optional. Recursive property for nested schema structures.

repeated .google.cloud.geminidataanalytics.v1beta.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FieldOrBuilder

getSubfieldsOrBuilderList()

public List<? extends FieldOrBuilder> getSubfieldsOrBuilderList()

Optional. Recursive property for nested schema structures.

repeated .google.cloud.geminidataanalytics.v1beta.Field subfields = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.geminidataanalytics.v1beta.FieldOrBuilder>

getSynonyms(int index)

public String getSynonyms(int index)

Optional. A list of alternative names or synonyms that can be used to refer to this field. For example: ["id", "customerid", "cust_id"]

repeated string synonyms = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The synonyms at the given index.

getSynonymsBytes(int index)

public ByteString getSynonymsBytes(int index)

Optional. A list of alternative names or synonyms that can be used to refer to this field. For example: ["id", "customerid", "cust_id"]

repeated string synonyms = 6 [(.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 synonyms at the given index.

getSynonymsCount()

public int getSynonymsCount()

Optional. A list of alternative names or synonyms that can be used to refer to this field. For example: ["id", "customerid", "cust_id"]

repeated string synonyms = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of synonyms.

getSynonymsList()

public ProtocolStringList getSynonymsList()

Optional. A list of alternative names or synonyms that can be used to refer to this field. For example: ["id", "customerid", "cust_id"]

repeated string synonyms = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the synonyms.

getTags(int index)

public String getTags(int index)

Optional. A list of tags or keywords associated with the field, used for categorization. For example: ["identifier", "customer", "pii"]

repeated string tags = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

Optional. A list of tags or keywords associated with the field, used for categorization. For example: ["identifier", "customer", "pii"]

repeated string tags = 7 [(.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 tags at the given index.

getTagsCount()

public int getTagsCount()

Optional. A list of tags or keywords associated with the field, used for categorization. For example: ["identifier", "customer", "pii"]

repeated string tags = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

Optional. A list of tags or keywords associated with the field, used for categorization. For example: ["identifier", "customer", "pii"]

repeated string tags = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the tags.

getType()

public String getType()

Optional. The type of the field.

string type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

Optional. The type of the field.

string type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for type.

getValueFormat()

public String getValueFormat()

Optional. Looker only. Value format of the field. Ref: https://cloud.google.com/looker/docs/reference/param-field-value-format

string value_format = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The valueFormat.

getValueFormatBytes()

public ByteString getValueFormatBytes()

Optional. Looker only. Value format of the field. Ref: https://cloud.google.com/looker/docs/reference/param-field-value-format

string value_format = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for valueFormat.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Field.Builder newBuilderForType()
Returns
Type Description
Field.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Field.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Field.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Field.Builder toBuilder()
Returns
Type Description
Field.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException