Class ListTensorboardRunsRequest.Builder (2.5.3)

Version 2.5.3

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class ListTensorboardRunsRequest.Builder extends GeneratedMessageV3.Builder<ListTensorboardRunsRequest.Builder> implements ListTensorboardRunsRequestOrBuilder

Request message for TensorboardService.ListTensorboardRuns.

Protobuf type google.cloud.aiplatform.v1.ListTensorboardRunsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListTensorboardRunsRequest.Builder

Implements

ListTensorboardRunsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTensorboardRunsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListTensorboardRunsRequest build()

Returns

Type	Description
ListTensorboardRunsRequest

buildPartial()

public ListTensorboardRunsRequest buildPartial()

Returns

Type	Description
ListTensorboardRunsRequest

clear()

public ListTensorboardRunsRequest.Builder clear()

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListTensorboardRunsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ListTensorboardRunsRequest.Builder clearFilter()

Lists the TensorboardRuns that match the filter expression.

string filter = 2;

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTensorboardRunsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderBy()

public ListTensorboardRunsRequest.Builder clearOrderBy()

Field to use to sort the list.

string order_by = 5;

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

clearPageSize()

public ListTensorboardRunsRequest.Builder clearPageSize()

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

int32 page_size = 3;

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

clearPageToken()

public ListTensorboardRunsRequest.Builder clearPageToken()

A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.

string page_token = 4;

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

clearParent()

public ListTensorboardRunsRequest.Builder clearParent()

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'

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

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

clearReadMask()

public ListTensorboardRunsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns

Type	Description
ListTensorboardRunsRequest.Builder

clone()

public ListTensorboardRunsRequest.Builder clone()

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListTensorboardRunsRequest getDefaultInstanceForType()

Returns

Type	Description
ListTensorboardRunsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

Lists the TensorboardRuns that match the filter expression.

string filter = 2;

Returns

Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Lists the TensorboardRuns 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 list.

string order_by = 5;

Returns

Type	Description
String	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Field to use to sort the list.

string order_by = 5;

Returns

Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public int getPageSize()

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

int32 page_size = 3;

Returns

Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns 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 TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.

string page_token = 4;

Returns

Type	Description
ByteString	The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'

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

Returns

Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'

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

Returns

Type	Description
ByteString	The bytes for parent.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns

Type	Description
FieldMask	The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns

Type	Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns

Type	Description
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns

Type	Description
boolean	Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListTensorboardRunsRequest other)

public ListTensorboardRunsRequest.Builder mergeFrom(ListTensorboardRunsRequest other)

Parameter

Name	Description
other	ListTensorboardRunsRequest

Returns

Type	Description
ListTensorboardRunsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTensorboardRunsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ListTensorboardRunsRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeReadMask(FieldMask value)

public ListTensorboardRunsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter

Name	Description
value	FieldMask

Returns

Type	Description
ListTensorboardRunsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTensorboardRunsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListTensorboardRunsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public ListTensorboardRunsRequest.Builder setFilter(String value)

Lists the TensorboardRuns that match the filter expression.

string filter = 2;

Parameter

Name	Description
value	String The filter to set.

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ListTensorboardRunsRequest.Builder setFilterBytes(ByteString value)

Lists the TensorboardRuns that match the filter expression.

string filter = 2;

Parameter

Name	Description
value	ByteString The bytes for filter to set.

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

setOrderBy(String value)

public ListTensorboardRunsRequest.Builder setOrderBy(String value)

Field to use to sort the list.

string order_by = 5;

Parameter

Name	Description
value	String The orderBy to set.

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

setOrderByBytes(ByteString value)

public ListTensorboardRunsRequest.Builder setOrderByBytes(ByteString value)

Field to use to sort the list.

string order_by = 5;

Parameter

Name	Description
value	ByteString The bytes for orderBy to set.

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

setPageSize(int value)

public ListTensorboardRunsRequest.Builder setPageSize(int value)

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

int32 page_size = 3;

Parameter

Name	Description
value	int The pageSize to set.

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListTensorboardRunsRequest.Builder setPageToken(String value)

A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns 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
ListTensorboardRunsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTensorboardRunsRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns 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
ListTensorboardRunsRequest.Builder	This builder for chaining.

setParent(String value)

public ListTensorboardRunsRequest.Builder setParent(String value)

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'

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

Parameter

Name	Description
value	String The parent to set.

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public ListTensorboardRunsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: 'projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}'

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

Parameter

Name	Description
value	ByteString The bytes for parent to set.

Returns

Type	Description
ListTensorboardRunsRequest.Builder	This builder for chaining.

setReadMask(FieldMask value)

public ListTensorboardRunsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter

Name	Description
value	FieldMask

Returns

Type	Description
ListTensorboardRunsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListTensorboardRunsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
ListTensorboardRunsRequest.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTensorboardRunsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ListTensorboardRunsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)