Class ExportTensorboardTimeSeriesDataRequest (3.46.0)

public final class ExportTensorboardTimeSeriesDataRequest extends GeneratedMessageV3 implements ExportTensorboardTimeSeriesDataRequestOrBuilder

Request message for TensorboardService.ExportTensorboardTimeSeriesData.

Protobuf type google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExportTensorboardTimeSeriesDataRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

TENSORBOARD_TIME_SERIES_FIELD_NUMBER

public static final int TENSORBOARD_TIME_SERIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportTensorboardTimeSeriesDataRequest getDefaultInstance()
Returns
Type Description
ExportTensorboardTimeSeriesDataRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ExportTensorboardTimeSeriesDataRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ExportTensorboardTimeSeriesDataRequest getDefaultInstanceForType()
Returns
Type Description
ExportTensorboardTimeSeriesDataRequest

getFilter()

public String getFilter()

Exports the TensorboardTimeSeries' data that match the filter expression.

string filter = 2;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Exports the TensorboardTimeSeries' data that match the filter expression.

string filter = 2;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order.

string order_by = 5;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Field to use to sort the TensorboardTimeSeries' data. By default, TensorboardTimeSeries' data is returned in a pseudo random order.

string order_by = 5;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The maximum number of data points to return per page. The default page_size is 1000. Values must be between 1 and 10000. Values above 10000 are coerced to 10000.

int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous ExportTensorboardTimeSeriesData call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ExportTensorboardTimeSeriesData must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTensorboardTimeSeries()

public String getTensorboardTimeSeries()

Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The tensorboardTimeSeries.

getTensorboardTimeSeriesBytes()

public ByteString getTensorboardTimeSeriesBytes()

Required. The resource name of the TensorboardTimeSeries to export data from. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}

string tensorboard_time_series = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for tensorboardTimeSeries.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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