Class ExportTensorboardTimeSeriesDataRequest.Builder (3.46.0)

public static final class ExportTensorboardTimeSeriesDataRequest.Builder extends GeneratedMessageV3.Builder<ExportTensorboardTimeSeriesDataRequest.Builder> implements ExportTensorboardTimeSeriesDataRequestOrBuilder

Request message for TensorboardService.ExportTensorboardTimeSeriesData.

Protobuf type google.cloud.aiplatform.v1.ExportTensorboardTimeSeriesDataRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ExportTensorboardTimeSeriesDataRequest build()
Returns
Type Description
ExportTensorboardTimeSeriesDataRequest

buildPartial()

public ExportTensorboardTimeSeriesDataRequest buildPartial()
Returns
Type Description
ExportTensorboardTimeSeriesDataRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ExportTensorboardTimeSeriesDataRequest.Builder clearFilter()

Exports the TensorboardTimeSeries' data that match the filter expression.

string filter = 2;

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ExportTensorboardTimeSeriesDataRequest.Builder clearOrderBy()

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
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clearPageSize()

public ExportTensorboardTimeSeriesDataRequest.Builder clearPageSize()

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
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clearPageToken()

public ExportTensorboardTimeSeriesDataRequest.Builder clearPageToken()

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
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clearTensorboardTimeSeries()

public ExportTensorboardTimeSeriesDataRequest.Builder clearTensorboardTimeSeries()

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
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ExportTensorboardTimeSeriesDataRequest getDefaultInstanceForType()
Returns
Type Description
ExportTensorboardTimeSeriesDataRequest

getDescriptorForType()

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ExportTensorboardTimeSeriesDataRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ExportTensorboardTimeSeriesDataRequest.Builder setFilter(String value)

Exports the TensorboardTimeSeries' data that match the filter expression.

string filter = 2;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ExportTensorboardTimeSeriesDataRequest.Builder setFilterBytes(ByteString value)

Exports the TensorboardTimeSeries' data that match the filter expression.

string filter = 2;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ExportTensorboardTimeSeriesDataRequest.Builder setOrderBy(String value)

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

string order_by = 5;

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ExportTensorboardTimeSeriesDataRequest.Builder setOrderByBytes(ByteString value)

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

string order_by = 5;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setPageSize(int value)

public ExportTensorboardTimeSeriesDataRequest.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setPageToken(String value)

public ExportTensorboardTimeSeriesDataRequest.Builder setPageToken(String value)

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;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ExportTensorboardTimeSeriesDataRequest.Builder setPageTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

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

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

setTensorboardTimeSeries(String value)

public ExportTensorboardTimeSeriesDataRequest.Builder setTensorboardTimeSeries(String value)

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) = { ... }

Parameter
Name Description
value String

The tensorboardTimeSeries to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setTensorboardTimeSeriesBytes(ByteString value)

public ExportTensorboardTimeSeriesDataRequest.Builder setTensorboardTimeSeriesBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for tensorboardTimeSeries to set.

Returns
Type Description
ExportTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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