Class ReadTensorboardTimeSeriesDataRequest.Builder (3.84.0)

public static final class ReadTensorboardTimeSeriesDataRequest.Builder extends GeneratedMessage.Builder<ReadTensorboardTimeSeriesDataRequest.Builder> implements ReadTensorboardTimeSeriesDataRequestOrBuilder

Request message for TensorboardService.ReadTensorboardTimeSeriesData.

Protobuf type google.cloud.aiplatform.v1.ReadTensorboardTimeSeriesDataRequest

Static Methods

getDescriptor()

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

Methods

build()

public ReadTensorboardTimeSeriesDataRequest build()
Returns
Type Description
ReadTensorboardTimeSeriesDataRequest

buildPartial()

public ReadTensorboardTimeSeriesDataRequest buildPartial()
Returns
Type Description
ReadTensorboardTimeSeriesDataRequest

clear()

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

clearFilter()

public ReadTensorboardTimeSeriesDataRequest.Builder clearFilter()

Reads the TensorboardTimeSeries' data that match the filter expression.

string filter = 3;

Returns
Type Description
ReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clearMaxDataPoints()

public ReadTensorboardTimeSeriesDataRequest.Builder clearMaxDataPoints()

The maximum number of TensorboardTimeSeries' data to return.

This value should be a positive integer. This value can be set to -1 to return all data.

int32 max_data_points = 2;

Returns
Type Description
ReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

clearTensorboardTimeSeries()

public ReadTensorboardTimeSeriesDataRequest.Builder clearTensorboardTimeSeries()

Required. The resource name of the TensorboardTimeSeries to read 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
ReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ReadTensorboardTimeSeriesDataRequest getDefaultInstanceForType()
Returns
Type Description
ReadTensorboardTimeSeriesDataRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Reads the TensorboardTimeSeries' data that match the filter expression.

string filter = 3;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Reads the TensorboardTimeSeries' data that match the filter expression.

string filter = 3;

Returns
Type Description
ByteString

The bytes for filter.

getMaxDataPoints()

public int getMaxDataPoints()

The maximum number of TensorboardTimeSeries' data to return.

This value should be a positive integer. This value can be set to -1 to return all data.

int32 max_data_points = 2;

Returns
Type Description
int

The maxDataPoints.

getTensorboardTimeSeries()

public String getTensorboardTimeSeries()

Required. The resource name of the TensorboardTimeSeries to read 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 read 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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ReadTensorboardTimeSeriesDataRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ReadTensorboardTimeSeriesDataRequest.Builder setFilter(String value)

Reads the TensorboardTimeSeries' data that match the filter expression.

string filter = 3;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ReadTensorboardTimeSeriesDataRequest.Builder setFilterBytes(ByteString value)

Reads the TensorboardTimeSeries' data that match the filter expression.

string filter = 3;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setMaxDataPoints(int value)

public ReadTensorboardTimeSeriesDataRequest.Builder setMaxDataPoints(int value)

The maximum number of TensorboardTimeSeries' data to return.

This value should be a positive integer. This value can be set to -1 to return all data.

int32 max_data_points = 2;

Parameter
Name Description
value int

The maxDataPoints to set.

Returns
Type Description
ReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setTensorboardTimeSeries(String value)

public ReadTensorboardTimeSeriesDataRequest.Builder setTensorboardTimeSeries(String value)

Required. The resource name of the TensorboardTimeSeries to read 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
ReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.

setTensorboardTimeSeriesBytes(ByteString value)

public ReadTensorboardTimeSeriesDataRequest.Builder setTensorboardTimeSeriesBytes(ByteString value)

Required. The resource name of the TensorboardTimeSeries to read 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
ReadTensorboardTimeSeriesDataRequest.Builder

This builder for chaining.