Interface LogTypeSchema.DetailsFieldSchemaOrBuilder (0.37.0)

public static interface LogTypeSchema.DetailsFieldSchemaOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

A human-readable description for this field.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A human-readable description for this field.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

A human-readable name for this field.

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

A human-readable name for this field.

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getEnumFieldSchemas(int index)

public abstract LogTypeSchema.EnumFieldSchema getEnumFieldSchemas(int index)

If a field has an enum type, this is the schema describing the possible values.

repeated .google.cloud.chronicle.v1.LogTypeSchema.EnumFieldSchema enum_field_schemas = 5;

Parameter
Name Description
index int
Returns
Type Description
LogTypeSchema.EnumFieldSchema

getEnumFieldSchemasCount()

public abstract int getEnumFieldSchemasCount()

If a field has an enum type, this is the schema describing the possible values.

repeated .google.cloud.chronicle.v1.LogTypeSchema.EnumFieldSchema enum_field_schemas = 5;

Returns
Type Description
int

getEnumFieldSchemasList()

public abstract List<LogTypeSchema.EnumFieldSchema> getEnumFieldSchemasList()

If a field has an enum type, this is the schema describing the possible values.

repeated .google.cloud.chronicle.v1.LogTypeSchema.EnumFieldSchema enum_field_schemas = 5;

Returns
Type Description
List<EnumFieldSchema>

getEnumFieldSchemasOrBuilder(int index)

public abstract LogTypeSchema.EnumFieldSchemaOrBuilder getEnumFieldSchemasOrBuilder(int index)

If a field has an enum type, this is the schema describing the possible values.

repeated .google.cloud.chronicle.v1.LogTypeSchema.EnumFieldSchema enum_field_schemas = 5;

Parameter
Name Description
index int
Returns
Type Description
LogTypeSchema.EnumFieldSchemaOrBuilder

getEnumFieldSchemasOrBuilderList()

public abstract List<? extends LogTypeSchema.EnumFieldSchemaOrBuilder> getEnumFieldSchemasOrBuilderList()

If a field has an enum type, this is the schema describing the possible values.

repeated .google.cloud.chronicle.v1.LogTypeSchema.EnumFieldSchema enum_field_schemas = 5;

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.LogTypeSchema.EnumFieldSchemaOrBuilder>

getExampleInput()

public abstract String getExampleInput()

For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.

string example_input = 7;

Returns
Type Description
String

The exampleInput.

getExampleInputBytes()

public abstract ByteString getExampleInputBytes()

For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.

string example_input = 7;

Returns
Type Description
ByteString

The bytes for exampleInput.

getFieldPath()

public abstract String getFieldPath()

The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".

string field_path = 1;

Returns
Type Description
String

The fieldPath.

getFieldPathBytes()

public abstract ByteString getFieldPathBytes()

The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".

string field_path = 1;

Returns
Type Description
ByteString

The bytes for fieldPath.

getReadOnly()

public abstract boolean getReadOnly()

For those fields which are read only.

bool read_only = 8;

Returns
Type Description
boolean

The readOnly.

getRequired()

public abstract boolean getRequired()

Whether this field must be specified to have a valid feed configuration.

bool required = 6;

Returns
Type Description
boolean

The required.

getType()

public abstract SemanticType getType()

A type that represents both the encoding and the semantics of this field.

.google.cloud.chronicle.v1.SemanticType type = 4;

Returns
Type Description
SemanticType

The type.

getTypeValue()

public abstract int getTypeValue()

A type that represents both the encoding and the semantics of this field.

.google.cloud.chronicle.v1.SemanticType type = 4;

Returns
Type Description
int

The enum numeric value on the wire for type.