ListTensorboardExperimentsRequest.Builder (proto-google-cloud-aiplatform-v1 3.86.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<ListTensorboardExperimentsRequest.Builder>
    - - com.google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest.Builder

All Implemented Interfaces:: ListTensorboardExperimentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: ListTensorboardExperimentsRequest

public static final class ListTensorboardExperimentsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListTensorboardExperimentsRequest.Builder>
implements ListTensorboardExperimentsRequestOrBuilder

 Request message for
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments].

Protobuf type google.cloud.aiplatform.v1.ListTensorboardExperimentsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListTensorboardExperimentsRequest`	`build()`
`ListTensorboardExperimentsRequest`	`buildPartial()`
`ListTensorboardExperimentsRequest.Builder`	`clear()`
`ListTensorboardExperimentsRequest.Builder`	`clearFilter()` Lists the TensorboardExperiments that match the filter expression.
`ListTensorboardExperimentsRequest.Builder`	`clearOrderBy()` Field to use to sort the list.
`ListTensorboardExperimentsRequest.Builder`	`clearPageSize()` The maximum number of TensorboardExperiments to return.
`ListTensorboardExperimentsRequest.Builder`	`clearPageToken()` A page token, received from a previous [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] call.
`ListTensorboardExperimentsRequest.Builder`	`clearParent()` Required.
`ListTensorboardExperimentsRequest.Builder`	`clearReadMask()` Mask specifying which fields to read.
`ListTensorboardExperimentsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getFilter()` Lists the TensorboardExperiments that match the filter expression.
`com.google.protobuf.ByteString`	`getFilterBytes()` Lists the TensorboardExperiments that match the filter expression.
`String`	`getOrderBy()` Field to use to sort the list.
`com.google.protobuf.ByteString`	`getOrderByBytes()` Field to use to sort the list.
`int`	`getPageSize()` The maximum number of TensorboardExperiments to return.
`String`	`getPageToken()` A page token, received from a previous [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] call.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` A page token, received from a previous [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] call.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`com.google.protobuf.FieldMask`	`getReadMask()` Mask specifying which fields to read.
`com.google.protobuf.FieldMask.Builder`	`getReadMaskBuilder()` Mask specifying which fields to read.
`com.google.protobuf.FieldMaskOrBuilder`	`getReadMaskOrBuilder()` Mask specifying which fields to read.
`boolean`	`hasReadMask()` Mask specifying which fields to read.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListTensorboardExperimentsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListTensorboardExperimentsRequest.Builder`	`mergeFrom(ListTensorboardExperimentsRequest other)`
`ListTensorboardExperimentsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListTensorboardExperimentsRequest.Builder`	`mergeReadMask(com.google.protobuf.FieldMask value)` Mask specifying which fields to read.
`ListTensorboardExperimentsRequest.Builder`	`setFilter(String value)` Lists the TensorboardExperiments that match the filter expression.
`ListTensorboardExperimentsRequest.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` Lists the TensorboardExperiments that match the filter expression.
`ListTensorboardExperimentsRequest.Builder`	`setOrderBy(String value)` Field to use to sort the list.
`ListTensorboardExperimentsRequest.Builder`	`setOrderByBytes(com.google.protobuf.ByteString value)` Field to use to sort the list.
`ListTensorboardExperimentsRequest.Builder`	`setPageSize(int value)` The maximum number of TensorboardExperiments to return.
`ListTensorboardExperimentsRequest.Builder`	`setPageToken(String value)` A page token, received from a previous [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] call.
`ListTensorboardExperimentsRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` A page token, received from a previous [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments] call.
`ListTensorboardExperimentsRequest.Builder`	`setParent(String value)` Required.
`ListTensorboardExperimentsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListTensorboardExperimentsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)` Mask specifying which fields to read.
`ListTensorboardExperimentsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask value)` Mask specifying which fields to read.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListTensorboardExperimentsRequest.Builder>

clear
```
public ListTensorboardExperimentsRequest.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<ListTensorboardExperimentsRequest.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListTensorboardExperimentsRequest.Builder>

getDefaultInstanceForType
```
public ListTensorboardExperimentsRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public ListTensorboardExperimentsRequest build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public ListTensorboardExperimentsRequest buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom
```
public ListTensorboardExperimentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListTensorboardExperimentsRequest.Builder>

mergeFrom

public ListTensorboardExperimentsRequest.Builder mergeFrom(ListTensorboardExperimentsRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListTensorboardExperimentsRequest.Builder>

mergeFrom

public ListTensorboardExperimentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Specified by:: mergeFrom in interface com.google.protobuf.Message.Builder
Specified by:: mergeFrom in interface com.google.protobuf.MessageLite.Builder
Overrides:: mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListTensorboardExperimentsRequest.Builder>
Throws:: IOException

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) = { ... }
Specified by:

getParent in interface ListTensorboardExperimentsRequestOrBuilder

Returns:

The parent.

getParentBytes
```
public com.google.protobuf.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) = { ... }
Specified by:

getParentBytes in interface ListTensorboardExperimentsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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) = { ... }

Parameters:: value - The parent to set.
Returns:: 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:: This builder for chaining.

setParentBytes

public ListTensorboardExperimentsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:: value - The bytes for parent to set.
Returns:: This builder for chaining.

getFilter
```
public String getFilter()
```
```
 Lists the TensorboardExperiments that match the filter expression.
 
```
string filter = 2;
Specified by:

getFilter in interface ListTensorboardExperimentsRequestOrBuilder

Returns:

The filter.

getFilterBytes
```
public com.google.protobuf.ByteString getFilterBytes()
```
```
 Lists the TensorboardExperiments that match the filter expression.
 
```
string filter = 2;
Specified by:

getFilterBytes in interface ListTensorboardExperimentsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ListTensorboardExperimentsRequest.Builder setFilter(String value)

 Lists the TensorboardExperiments that match the filter expression.

string filter = 2;

Parameters:: value - The filter to set.
Returns:: This builder for chaining.

clearFilter

public ListTensorboardExperimentsRequest.Builder clearFilter()

 Lists the TensorboardExperiments that match the filter expression.

string filter = 2;

Returns:: This builder for chaining.

setFilterBytes

public ListTensorboardExperimentsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

 Lists the TensorboardExperiments that match the filter expression.

string filter = 2;

Parameters:: value - The bytes for filter to set.
Returns:: This builder for chaining.

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;

Specified by:: getPageSize in interface ListTensorboardExperimentsRequestOrBuilder
Returns:: The pageSize.

setPageSize

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;

Parameters:: value - The pageSize to set.
Returns:: 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:: This builder for chaining.

getPageToken

public String getPageToken()

 A page token, received from a previous
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 must match the call that provided the page token.

string page_token = 4;

Specified by:: getPageToken in interface ListTensorboardExperimentsRequestOrBuilder
Returns:: The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 A page token, received from a previous
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 must match the call that provided the page token.

string page_token = 4;

Specified by:: getPageTokenBytes in interface ListTensorboardExperimentsRequestOrBuilder
Returns:: The bytes for pageToken.

setPageToken

public ListTensorboardExperimentsRequest.Builder setPageToken(String value)

 A page token, received from a previous
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 must match the call that provided the page token.

string page_token = 4;

Parameters:: value - The pageToken to set.
Returns:: This builder for chaining.

clearPageToken

public ListTensorboardExperimentsRequest.Builder clearPageToken()

 A page token, received from a previous
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 must match the call that provided the page token.

string page_token = 4;

Returns:: This builder for chaining.

setPageTokenBytes

public ListTensorboardExperimentsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 A page token, received from a previous
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [TensorboardService.ListTensorboardExperiments][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardExperiments]
 must match the call that provided the page token.

string page_token = 4;

Parameters:: value - The bytes for pageToken to set.
Returns:: This builder for chaining.

getOrderBy
```
public String getOrderBy()
```
```
 Field to use to sort the list.
 
```
string order_by = 5;
Specified by:

getOrderBy in interface ListTensorboardExperimentsRequestOrBuilder

Returns:

The orderBy.

getOrderByBytes
```
public com.google.protobuf.ByteString getOrderByBytes()
```
```
 Field to use to sort the list.
 
```
string order_by = 5;
Specified by:

getOrderByBytes in interface ListTensorboardExperimentsRequestOrBuilder

Returns:

The bytes for orderBy.

setOrderBy

public ListTensorboardExperimentsRequest.Builder setOrderBy(String value)

 Field to use to sort the list.

string order_by = 5;

Parameters:: value - The orderBy to set.
Returns:: This builder for chaining.

clearOrderBy

public ListTensorboardExperimentsRequest.Builder clearOrderBy()

 Field to use to sort the list.

string order_by = 5;

Returns:: This builder for chaining.

setOrderByBytes

public ListTensorboardExperimentsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)

 Field to use to sort the list.

string order_by = 5;

Parameters:: value - The bytes for orderBy to set.
Returns:: This builder for chaining.

hasReadMask
```
public boolean hasReadMask()
```
```
 Mask specifying which fields to read.
 
```
.google.protobuf.FieldMask read_mask = 6;
Specified by:

hasReadMask in interface ListTensorboardExperimentsRequestOrBuilder

Returns:

Whether the readMask field is set.

getReadMask
```
public com.google.protobuf.FieldMask getReadMask()
```
```
 Mask specifying which fields to read.
 
```
.google.protobuf.FieldMask read_mask = 6;
Specified by:

getReadMask in interface ListTensorboardExperimentsRequestOrBuilder

Returns:

The readMask.