Class ListTensorboardExperimentsRequest.Builder (3.38.0)

public static final class ListTensorboardExperimentsRequest.Builder extends GeneratedMessageV3.Builder<ListTensorboardExperimentsRequest.Builder> implements ListTensorboardExperimentsRequestOrBuilder

Request message for TensorboardService.ListTensorboardExperiments.

Protobuf type google.cloud.aiplatform.v1beta1.ListTensorboardExperimentsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListTensorboardExperimentsRequest build()
Returns
TypeDescription
ListTensorboardExperimentsRequest

buildPartial()

public ListTensorboardExperimentsRequest buildPartial()
Returns
TypeDescription
ListTensorboardExperimentsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListTensorboardExperimentsRequest.Builder clearFilter()

Lists the TensorboardExperiments that match the filter expression.

string filter = 2;

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListTensorboardExperimentsRequest.Builder clearOrderBy()

Field to use to sort the list.

string order_by = 5;

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

clearPageSize()

public ListTensorboardExperimentsRequest.Builder clearPageSize()

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

int32 page_size = 3;

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

clearPageToken()

public ListTensorboardExperimentsRequest.Builder clearPageToken()

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

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

string page_token = 4;

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

clearParent()

public ListTensorboardExperimentsRequest.Builder clearParent()

Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

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

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

clearReadMask()

public ListTensorboardExperimentsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

clone()

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

getDefaultInstanceForType()

public ListTensorboardExperimentsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListTensorboardExperimentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Lists the TensorboardExperiments that match the filter expression.

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Lists the TensorboardExperiments 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 TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments 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.ListTensorboardExperiments call. Provide this to retrieve the subsequent page.

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

When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments 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 Tensorboard to list TensorboardExperiments. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

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 Tensorboard to list TensorboardExperiments. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

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

public ListTensorboardExperimentsRequest.Builder mergeFrom(ListTensorboardExperimentsRequest other)
Parameter
NameDescription
otherListTensorboardExperimentsRequest
Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadMask(FieldMask value)

public ListTensorboardExperimentsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListTensorboardExperimentsRequest.Builder setFilter(String value)

Lists the TensorboardExperiments that match the filter expression.

string filter = 2;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListTensorboardExperimentsRequest.Builder setFilterBytes(ByteString value)

Lists the TensorboardExperiments that match the filter expression.

string filter = 2;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListTensorboardExperimentsRequest.Builder setOrderBy(String value)

Field to use to sort the list.

string order_by = 5;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

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

This builder for chaining.

setPageSize(int value)

public ListTensorboardExperimentsRequest.Builder setPageSize(int value)

The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments 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
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTensorboardExperimentsRequest.Builder setPageToken(String value)

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

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

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTensorboardExperimentsRequest.Builder setPageTokenBytes(ByteString value)

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

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

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

setParent(String value)

public ListTensorboardExperimentsRequest.Builder setParent(String value)

Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTensorboardExperimentsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListTensorboardExperimentsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListTensorboardExperimentsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListTensorboardExperimentsRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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