Class ListTensorboardsRequest.Builder (3.42.0)

public static final class ListTensorboardsRequest.Builder extends GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder> implements ListTensorboardsRequestOrBuilder

Request message for TensorboardService.ListTensorboards.

Protobuf type google.cloud.aiplatform.v1.ListTensorboardsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListTensorboardsRequest build()
Returns
TypeDescription
ListTensorboardsRequest

buildPartial()

public ListTensorboardsRequest buildPartial()
Returns
TypeDescription
ListTensorboardsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListTensorboardsRequest.Builder clearFilter()

Lists the Tensorboards that match the filter expression.

string filter = 2;

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListTensorboardsRequest.Builder clearOrderBy()

Field to use to sort the list.

string order_by = 5;

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

clearPageSize()

public ListTensorboardsRequest.Builder clearPageSize()

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

int32 page_size = 3;

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

clearPageToken()

public ListTensorboardsRequest.Builder clearPageToken()

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

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

string page_token = 4;

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

clearParent()

public ListTensorboardsRequest.Builder clearParent()

Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}

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

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

clearReadMask()

public ListTensorboardsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
ListTensorboardsRequest.Builder

clone()

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

getDefaultInstanceForType()

public ListTensorboardsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListTensorboardsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Lists the Tensorboards that match the filter expression.

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Lists the Tensorboards 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 Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

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

When paginating, all other parameters provided to TensorboardService.ListTensorboards 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.ListTensorboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to TensorboardService.ListTensorboards 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 Location to list Tensorboards. Format: projects/{project}/locations/{location}

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 Location to list Tensorboards. Format: projects/{project}/locations/{location}

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(ListTensorboardsRequest other)

public ListTensorboardsRequest.Builder mergeFrom(ListTensorboardsRequest other)
Parameter
NameDescription
otherListTensorboardsRequest
Returns
TypeDescription
ListTensorboardsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadMask(FieldMask value)

public ListTensorboardsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListTensorboardsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListTensorboardsRequest.Builder setFilter(String value)

Lists the Tensorboards that match the filter expression.

string filter = 2;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListTensorboardsRequest.Builder setFilterBytes(ByteString value)

Lists the Tensorboards that match the filter expression.

string filter = 2;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListTensorboardsRequest.Builder setOrderBy(String value)

Field to use to sort the list.

string order_by = 5;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListTensorboardsRequest.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
ListTensorboardsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListTensorboardsRequest.Builder setPageSize(int value)

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

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTensorboardsRequest.Builder setPageToken(String value)

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

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

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTensorboardsRequest.Builder setPageTokenBytes(ByteString value)

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

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

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

setParent(String value)

public ListTensorboardsRequest.Builder setParent(String value)

Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTensorboardsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListTensorboardsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListTensorboardsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListTensorboardsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListTensorboardsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListTensorboardsRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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