Package com.google.cloud.aiplatform.v1
Class ListTensorboardRunsRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListTensorboardRunsRequest.Builder>
com.google.cloud.aiplatform.v1.ListTensorboardRunsRequest.Builder
- All Implemented Interfaces:
ListTensorboardRunsRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- ListTensorboardRunsRequest
public static final class ListTensorboardRunsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListTensorboardRunsRequest.Builder>
implements ListTensorboardRunsRequestOrBuilder
Request message for [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns].Protobuf type
google.cloud.aiplatform.v1.ListTensorboardRunsRequest-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()Lists the TensorboardRuns that match the filter expression.Field to use to sort the list.The maximum number of TensorboardRuns to return.A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call.Required.Mask specifying which fields to read.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorLists the TensorboardRuns that match the filter expression.com.google.protobuf.ByteStringLists the TensorboardRuns that match the filter expression.Field to use to sort the list.com.google.protobuf.ByteStringField to use to sort the list.intThe maximum number of TensorboardRuns to return.A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call.com.google.protobuf.ByteStringA page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call.Required.com.google.protobuf.ByteStringRequired.com.google.protobuf.FieldMaskMask specifying which fields to read.com.google.protobuf.FieldMask.BuilderMask specifying which fields to read.com.google.protobuf.FieldMaskOrBuilderMask specifying which fields to read.booleanMask specifying which fields to read.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeReadMask(com.google.protobuf.FieldMask value) Mask specifying which fields to read.Lists the TensorboardRuns that match the filter expression.setFilterBytes(com.google.protobuf.ByteString value) Lists the TensorboardRuns that match the filter expression.setOrderBy(String value) Field to use to sort the list.setOrderByBytes(com.google.protobuf.ByteString value) Field to use to sort the list.setPageSize(int value) The maximum number of TensorboardRuns to return.setPageToken(String value) A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call.setPageTokenBytes(com.google.protobuf.ByteString value) A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call.Required.setParentBytes(com.google.protobuf.ByteString value) Required.setReadMask(com.google.protobuf.FieldMask value) Mask specifying which fields to read.setReadMask(com.google.protobuf.FieldMask.Builder builderForValue) 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, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<ListTensorboardRunsRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<ListTensorboardRunsRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<ListTensorboardRunsRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ListTensorboardRunsRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<ListTensorboardRunsRequest.Builder>
-
mergeFrom
public ListTensorboardRunsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ListTensorboardRunsRequest.Builder>- Throws:
IOException
-
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) = { ... }- Specified by:
getParentin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The parent.
-
getParentBytes
public com.google.protobuf.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) = { ... }- Specified by:
getParentBytesin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The bytes for parent.
-
setParent
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) = { ... }- Parameters:
value- The parent to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
setParentBytes
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) = { ... }- Parameters:
value- The bytes for parent to set.- Returns:
- This builder for chaining.
-
getFilter
Lists the TensorboardRuns that match the filter expression.
string filter = 2;- Specified by:
getFilterin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()Lists the TensorboardRuns that match the filter expression.
string filter = 2;- Specified by:
getFilterBytesin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The bytes for filter.
-
setFilter
Lists the TensorboardRuns that match the filter expression.
string filter = 2;- Parameters:
value- The filter to set.- Returns:
- This builder for chaining.
-
clearFilter
Lists the TensorboardRuns that match the filter expression.
string filter = 2;- Returns:
- This builder for chaining.
-
setFilterBytes
Lists the TensorboardRuns 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 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;- Specified by:
getPageSizein interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The pageSize.
-
setPageSize
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;- Parameters:
value- The pageSize to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
getPageToken
A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] must match the call that provided the page token.
string page_token = 4;- Specified by:
getPageTokenin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The pageToken.
-
getPageTokenBytes
public com.google.protobuf.ByteString getPageTokenBytes()A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] must match the call that provided the page token.
string page_token = 4;- Specified by:
getPageTokenBytesin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The bytes for pageToken.
-
setPageToken
A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] 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
A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] must match the call that provided the page token.
string page_token = 4;- Returns:
- This builder for chaining.
-
setPageTokenBytes
A page token, received from a previous [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [TensorboardService.ListTensorboardRuns][google.cloud.aiplatform.v1.TensorboardService.ListTensorboardRuns] 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
Field to use to sort the list.
string order_by = 5;- Specified by:
getOrderByin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The orderBy.
-
getOrderByBytes
public com.google.protobuf.ByteString getOrderByBytes()Field to use to sort the list.
string order_by = 5;- Specified by:
getOrderByBytesin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The bytes for orderBy.
-
setOrderBy
Field to use to sort the list.
string order_by = 5;- Parameters:
value- The orderBy to set.- Returns:
- This builder for chaining.
-
clearOrderBy
Field to use to sort the list.
string order_by = 5;- Returns:
- This builder for chaining.
-
setOrderByBytes
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:
hasReadMaskin interfaceListTensorboardRunsRequestOrBuilder- 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:
getReadMaskin interfaceListTensorboardRunsRequestOrBuilder- Returns:
- The readMask.
-
setReadMask
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6; -
setReadMask
public ListTensorboardRunsRequest.Builder setReadMask(com.google.protobuf.FieldMask.Builder builderForValue) Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6; -
mergeReadMask
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6; -
clearReadMask
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6; -
getReadMaskBuilder
public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6; -
getReadMaskOrBuilder
public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;- Specified by:
getReadMaskOrBuilderin interfaceListTensorboardRunsRequestOrBuilder
-