Class Example.Builder (3.64.0)

public static final class Example.Builder extends GeneratedMessageV3.Builder.Builder> implements ExampleOrBuilder

A single example to upload or read from the Example Store.

Protobuf type google.cloud.aiplatform.v1beta1.Example

Implements

ExampleOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Example build()
Returns
Type Description
Example

buildPartial()

public Example buildPartial()
Returns
Type Description
Example

clear()

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

clearCreateTime()

public Example.Builder clearCreateTime()

Output only. Timestamp when this Example was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Example.Builder

clearDisplayName()

public Example.Builder clearDisplayName()

Optional. The display name for Example.

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

Returns
Type Description
Example.Builder

This builder for chaining.

clearExampleId()

public Example.Builder clearExampleId()

Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.

string example_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Example.Builder

This builder for chaining.

clearExampleType()

public Example.Builder clearExampleType()
Returns
Type Description
Example.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearStoredContentsExample()

public Example.Builder clearStoredContentsExample()

An example of chat history and its expected outcome to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.StoredContentsExample stored_contents_example = 6;

Returns
Type Description
Example.Builder

clone()

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

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this Example was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this Example was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Example was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Example getDefaultInstanceForType()
Returns
Type Description
Example

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. The display name for Example.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The display name for Example.

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

Returns
Type Description
ByteString

The bytes for displayName.

getExampleId()

public String getExampleId()

Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.

string example_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The exampleId.

getExampleIdBytes()

public ByteString getExampleIdBytes()

Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.

string example_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for exampleId.

getExampleTypeCase()

public Example.ExampleTypeCase getExampleTypeCase()
Returns
Type Description
Example.ExampleTypeCase

getStoredContentsExample()

public StoredContentsExample getStoredContentsExample()

An example of chat history and its expected outcome to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.StoredContentsExample stored_contents_example = 6;

Returns
Type Description
StoredContentsExample

The storedContentsExample.

getStoredContentsExampleBuilder()

public StoredContentsExample.Builder getStoredContentsExampleBuilder()

An example of chat history and its expected outcome to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.StoredContentsExample stored_contents_example = 6;

Returns
Type Description
StoredContentsExample.Builder

getStoredContentsExampleOrBuilder()

public StoredContentsExampleOrBuilder getStoredContentsExampleOrBuilder()

An example of chat history and its expected outcome to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.StoredContentsExample stored_contents_example = 6;

Returns
Type Description
StoredContentsExampleOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Example was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasStoredContentsExample()

public boolean hasStoredContentsExample()

An example of chat history and its expected outcome to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.StoredContentsExample stored_contents_example = 6;

Returns
Type Description
boolean

Whether the storedContentsExample field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Example.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this Example was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Example.Builder

mergeFrom(Example other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeStoredContentsExample(StoredContentsExample value)

public Example.Builder mergeStoredContentsExample(StoredContentsExample value)

An example of chat history and its expected outcome to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.StoredContentsExample stored_contents_example = 6;

Parameter
Name Description
value StoredContentsExample
Returns
Type Description
Example.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCreateTime(Timestamp value)

public Example.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this Example was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Example.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Example.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Example was created.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Example.Builder

setDisplayName(String value)

public Example.Builder setDisplayName(String value)

Optional. The display name for Example.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Example.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Example.Builder setDisplayNameBytes(ByteString value)

Optional. The display name for Example.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Example.Builder

This builder for chaining.

setExampleId(String value)

public Example.Builder setExampleId(String value)

Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.

string example_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The exampleId to set.

Returns
Type Description
Example.Builder

This builder for chaining.

setExampleIdBytes(ByteString value)

public Example.Builder setExampleIdBytes(ByteString value)

Optional. Immutable. Unique identifier of an example. If not specified when upserting new examples, the example_id will be generated.

string example_id = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for exampleId to set.

Returns
Type Description
Example.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setStoredContentsExample(StoredContentsExample value)

public Example.Builder setStoredContentsExample(StoredContentsExample value)

An example of chat history and its expected outcome to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.StoredContentsExample stored_contents_example = 6;

Parameter
Name Description
value StoredContentsExample
Returns
Type Description
Example.Builder

setStoredContentsExample(StoredContentsExample.Builder builderForValue)

public Example.Builder setStoredContentsExample(StoredContentsExample.Builder builderForValue)

An example of chat history and its expected outcome to be used with GenerateContent.

.google.cloud.aiplatform.v1beta1.StoredContentsExample stored_contents_example = 6;

Parameter
Name Description
builderForValue StoredContentsExample.Builder
Returns
Type Description
Example.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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