Class TensorboardTimeSeries (3.45.0)

public final class TensorboardTimeSeries extends GeneratedMessageV3 implements TensorboardTimeSeriesOrBuilder

TensorboardTimeSeries maps to times series produced in training runs

Protobuf type google.cloud.aiplatform.v1beta1.TensorboardTimeSeries

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_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

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PLUGIN_DATA_FIELD_NUMBER

public static final int PLUGIN_DATA_FIELD_NUMBER
Field Value
Type Description
int

PLUGIN_NAME_FIELD_NUMBER

public static final int PLUGIN_NAME_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VALUE_TYPE_FIELD_NUMBER

public static final int VALUE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TensorboardTimeSeries getDefaultInstance()
Returns
Type Description
TensorboardTimeSeries

getDescriptor()

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

newBuilder()

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

newBuilder(TensorboardTimeSeries prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this TensorboardTimeSeries was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this TensorboardTimeSeries was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public TensorboardTimeSeries getDefaultInstanceForType()
Returns
Type Description
TensorboardTimeSeries

getDescription()

public String getDescription()

Description of this TensorboardTimeSeries.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of this TensorboardTimeSeries.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource).

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

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

string etag = 7;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 7;

Returns
Type Description
ByteString

The bytes for etag.

getMetadata()

public TensorboardTimeSeries.Metadata getMetadata()

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.Metadata

The metadata.

getMetadataOrBuilder()

public TensorboardTimeSeries.MetadataOrBuilder getMetadataOrBuilder()

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TensorboardTimeSeries.MetadataOrBuilder

getName()

public String getName()

Output only. Name of the TensorboardTimeSeries.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of the TensorboardTimeSeries.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPluginData()

public ByteString getPluginData()

Data of the current plugin, with the size limited to 65KB.

bytes plugin_data = 9;

Returns
Type Description
ByteString

The pluginData.

getPluginName()

public String getPluginName()

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The pluginName.

getPluginNameBytes()

public ByteString getPluginNameBytes()

Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob

string plugin_name = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for pluginName.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this TensorboardTimeSeries was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this TensorboardTimeSeries was last updated.

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

Returns
Type Description
TimestampOrBuilder

getValueType()

public TensorboardTimeSeries.ValueType getValueType()

Required. Immutable. Type of TensorboardTimeSeries value.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
TensorboardTimeSeries.ValueType

The valueType.

getValueTypeValue()

public int getValueTypeValue()

Required. Immutable. Type of TensorboardTimeSeries value.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.ValueType value_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for valueType.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this TensorboardTimeSeries was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasMetadata()

public boolean hasMetadata()

Output only. Scalar, Tensor, or Blob metadata for this TensorboardTimeSeries.

.google.cloud.aiplatform.v1beta1.TensorboardTimeSeries.Metadata metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the metadata field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this TensorboardTimeSeries 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.

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 TensorboardTimeSeries.Builder newBuilderForType()
Returns
Type Description
TensorboardTimeSeries.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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