Class ListTensorboardTimeSeriesRequest.Builder (3.32.0)

public static final class ListTensorboardTimeSeriesRequest.Builder extends GeneratedMessageV3.Builder<ListTensorboardTimeSeriesRequest.Builder> implements ListTensorboardTimeSeriesRequestOrBuilder

Request message for TensorboardService.ListTensorboardTimeSeries.

Protobuf type google.cloud.aiplatform.v1.ListTensorboardTimeSeriesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTensorboardTimeSeriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

build()

public ListTensorboardTimeSeriesRequest build()
Returns
TypeDescription
ListTensorboardTimeSeriesRequest

buildPartial()

public ListTensorboardTimeSeriesRequest buildPartial()
Returns
TypeDescription
ListTensorboardTimeSeriesRequest

clear()

public ListTensorboardTimeSeriesRequest.Builder clear()
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListTensorboardTimeSeriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

clearFilter()

public ListTensorboardTimeSeriesRequest.Builder clearFilter()

Lists the TensorboardTimeSeries that match the filter expression.

string filter = 2;

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTensorboardTimeSeriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

clearOrderBy()

public ListTensorboardTimeSeriesRequest.Builder clearOrderBy()

Field to use to sort the list.

string order_by = 5;

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

clearPageSize()

public ListTensorboardTimeSeriesRequest.Builder clearPageSize()

The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

int32 page_size = 3;

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

clearPageToken()

public ListTensorboardTimeSeriesRequest.Builder clearPageToken()

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

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

string page_token = 4;

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

clearParent()

public ListTensorboardTimeSeriesRequest.Builder clearParent()

Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

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

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

clearReadMask()

public ListTensorboardTimeSeriesRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

clone()

public ListTensorboardTimeSeriesRequest.Builder clone()
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListTensorboardTimeSeriesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListTensorboardTimeSeriesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Lists the TensorboardTimeSeries that match the filter expression.

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Lists the TensorboardTimeSeries that match the filter expression.

string filter = 2;

Returns
TypeDescription
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Field to use to sort the list.

string order_by = 5;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Field to use to sort the list.

string order_by = 5;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

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

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

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

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

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

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

Returns
TypeDescription
ByteString

The bytes for parent.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListTensorboardTimeSeriesRequest other)

public ListTensorboardTimeSeriesRequest.Builder mergeFrom(ListTensorboardTimeSeriesRequest other)
Parameter
NameDescription
otherListTensorboardTimeSeriesRequest
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTensorboardTimeSeriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListTensorboardTimeSeriesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListTensorboardTimeSeriesRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTensorboardTimeSeriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListTensorboardTimeSeriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

setFilter(String value)

public ListTensorboardTimeSeriesRequest.Builder setFilter(String value)

Lists the TensorboardTimeSeries that match the filter expression.

string filter = 2;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListTensorboardTimeSeriesRequest.Builder setFilterBytes(ByteString value)

Lists the TensorboardTimeSeries that match the filter expression.

string filter = 2;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListTensorboardTimeSeriesRequest.Builder setOrderBy(String value)

Field to use to sort the list.

string order_by = 5;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListTensorboardTimeSeriesRequest.Builder setOrderByBytes(ByteString value)

Field to use to sort the list.

string order_by = 5;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListTensorboardTimeSeriesRequest.Builder setPageSize(int value)

The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTensorboardTimeSeriesRequest.Builder setPageToken(String value)

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

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

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTensorboardTimeSeriesRequest.Builder setPageTokenBytes(ByteString value)

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

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

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setParent(String value)

public ListTensorboardTimeSeriesRequest.Builder setParent(String value)

Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTensorboardTimeSeriesRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListTensorboardTimeSeriesRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListTensorboardTimeSeriesRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder

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

public ListTensorboardTimeSeriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTensorboardTimeSeriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListTensorboardTimeSeriesRequest.Builder
Overrides