Class ListTensorboardRunsRequest.Builder (3.50.0)

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

Request message for TensorboardService.ListTensorboardRuns.

Protobuf type google.cloud.aiplatform.v1beta1.ListTensorboardRunsRequest

Static Methods

getDescriptor()

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

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

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

clearField(Descriptors.FieldDescriptor field)

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

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

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 are returned. The maximum value is 1000; values above 1000 are 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

getDefaultInstanceForType()

public ListTensorboardRunsRequest getDefaultInstanceForType()
Returns
Type Description
ListTensorboardRunsRequest

getDescriptorForType()

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

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 are returned. The maximum value is 1000; values above 1000 are 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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

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

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

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 are returned. The maximum value is 1000; values above 1000 are 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

setUnknownFields(UnknownFieldSet unknownFields)

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