Class DatasetVersion.Builder (3.84.0)

public static final class DatasetVersion.Builder extends GeneratedMessage.Builder<DatasetVersion.Builder> implements DatasetVersionOrBuilder

Describes the dataset version.

Protobuf type google.cloud.aiplatform.v1.DatasetVersion

Static Methods

getDescriptor()

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

Methods

build()

public DatasetVersion build()
Returns
Type Description
DatasetVersion

buildPartial()

public DatasetVersion buildPartial()
Returns
Type Description
DatasetVersion

clear()

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

clearBigQueryDatasetName()

public DatasetVersion.Builder clearBigQueryDatasetName()

Output only. Name of the associated BigQuery dataset.

string big_query_dataset_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

clearCreateTime()

public DatasetVersion.Builder clearCreateTime()

Output only. Timestamp when this DatasetVersion was created.

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

Returns
Type Description
DatasetVersion.Builder

clearDisplayName()

public DatasetVersion.Builder clearDisplayName()

The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 7;

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

clearEtag()

public DatasetVersion.Builder clearEtag()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 3;

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

clearMetadata()

public DatasetVersion.Builder clearMetadata()

Required. Output only. Additional information about the DatasetVersion.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatasetVersion.Builder

clearModelReference()

public DatasetVersion.Builder clearModelReference()

Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.

string model_reference = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

clearName()

public DatasetVersion.Builder clearName()

Output only. Identifier. The resource name of the DatasetVersion.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

clearSatisfiesPzi()

public DatasetVersion.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

clearSatisfiesPzs()

public DatasetVersion.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

clearUpdateTime()

public DatasetVersion.Builder clearUpdateTime()

Output only. Timestamp when this DatasetVersion was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatasetVersion.Builder

getBigQueryDatasetName()

public String getBigQueryDatasetName()

Output only. Name of the associated BigQuery dataset.

string big_query_dataset_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The bigQueryDatasetName.

getBigQueryDatasetNameBytes()

public ByteString getBigQueryDatasetNameBytes()

Output only. Name of the associated BigQuery dataset.

string big_query_dataset_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for bigQueryDatasetName.

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this DatasetVersion was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this DatasetVersion was created.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this DatasetVersion was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DatasetVersion getDefaultInstanceForType()
Returns
Type Description
DatasetVersion

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 7;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 7;

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 3;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 3;

Returns
Type Description
ByteString

The bytes for etag.

getMetadata()

public Value getMetadata()

Required. Output only. Additional information about the DatasetVersion.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Value

The metadata.

getMetadataBuilder()

public Value.Builder getMetadataBuilder()

Required. Output only. Additional information about the DatasetVersion.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Builder

getMetadataOrBuilder()

public ValueOrBuilder getMetadataOrBuilder()

Required. Output only. Additional information about the DatasetVersion.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ValueOrBuilder

getModelReference()

public String getModelReference()

Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.

string model_reference = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The modelReference.

getModelReferenceBytes()

public ByteString getModelReferenceBytes()

Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.

string model_reference = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for modelReference.

getName()

public String getName()

Output only. Identifier. The resource name of the DatasetVersion.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. The resource name of the DatasetVersion.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this DatasetVersion was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this DatasetVersion was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this DatasetVersion was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this DatasetVersion was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetadata()

public boolean hasMetadata()

Required. Output only. Additional information about the DatasetVersion.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the metadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this DatasetVersion was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public DatasetVersion.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this DatasetVersion was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DatasetVersion.Builder

mergeFrom(DatasetVersion other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMetadata(Value value)

public DatasetVersion.Builder mergeMetadata(Value value)

Required. Output only. Additional information about the DatasetVersion.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Value
Returns
Type Description
DatasetVersion.Builder

mergeUpdateTime(Timestamp value)

public DatasetVersion.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this DatasetVersion was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DatasetVersion.Builder

setBigQueryDatasetName(String value)

public DatasetVersion.Builder setBigQueryDatasetName(String value)

Output only. Name of the associated BigQuery dataset.

string big_query_dataset_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The bigQueryDatasetName to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setBigQueryDatasetNameBytes(ByteString value)

public DatasetVersion.Builder setBigQueryDatasetNameBytes(ByteString value)

Output only. Name of the associated BigQuery dataset.

string big_query_dataset_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for bigQueryDatasetName to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public DatasetVersion.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this DatasetVersion was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DatasetVersion.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DatasetVersion.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this DatasetVersion was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatasetVersion.Builder

setDisplayName(String value)

public DatasetVersion.Builder setDisplayName(String value)

The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 7;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DatasetVersion.Builder setDisplayNameBytes(ByteString value)

The user-defined name of the DatasetVersion. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 7;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setEtag(String value)

public DatasetVersion.Builder setEtag(String value)

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 3;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public DatasetVersion.Builder setEtagBytes(ByteString value)

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 3;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setMetadata(Value value)

public DatasetVersion.Builder setMetadata(Value value)

Required. Output only. Additional information about the DatasetVersion.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Value
Returns
Type Description
DatasetVersion.Builder

setMetadata(Value.Builder builderForValue)

public DatasetVersion.Builder setMetadata(Value.Builder builderForValue)

Required. Output only. Additional information about the DatasetVersion.

.google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatasetVersion.Builder

setModelReference(String value)

public DatasetVersion.Builder setModelReference(String value)

Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.

string model_reference = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The modelReference to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setModelReferenceBytes(ByteString value)

public DatasetVersion.Builder setModelReferenceBytes(ByteString value)

Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.

string model_reference = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for modelReference to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setName(String value)

public DatasetVersion.Builder setName(String value)

Output only. Identifier. The resource name of the DatasetVersion.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DatasetVersion.Builder setNameBytes(ByteString value)

Output only. Identifier. The resource name of the DatasetVersion.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setSatisfiesPzi(boolean value)

public DatasetVersion.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

bool satisfies_pzi = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzi to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setSatisfiesPzs(boolean value)

public DatasetVersion.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

bool satisfies_pzs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.

Returns
Type Description
DatasetVersion.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public DatasetVersion.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this DatasetVersion was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DatasetVersion.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DatasetVersion.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this DatasetVersion was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DatasetVersion.Builder