Class ListTensorboardsRequest.Builder

  • All Implemented Interfaces:
    ListTensorboardsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ListTensorboardsRequest

    public static final class ListTensorboardsRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
    implements ListTensorboardsRequestOrBuilder
     Request message for
     [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards].
     
    Protobuf type google.cloud.aiplatform.v1beta1.ListTensorboardsRequest
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
      • clear

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

        public ListTensorboardsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public ListTensorboardsRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public ListTensorboardsRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public ListTensorboardsRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
      • clearField

        public ListTensorboardsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
      • clearOneof

        public ListTensorboardsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
      • setRepeatedField

        public ListTensorboardsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                int index,
                                                                Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
      • addRepeatedField

        public ListTensorboardsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
      • mergeFrom

        public ListTensorboardsRequest.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<ListTensorboardsRequest.Builder>
        Throws:
        IOException
      • 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) = { ... }
        Specified by:
        getParent in interface ListTensorboardsRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getParentBytes in interface ListTensorboardsRequestOrBuilder
        Returns:
        The bytes for parent.
      • setParent

        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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        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:
        This builder for chaining.
      • setParentBytes

        public ListTensorboardsRequest.Builder setParentBytes​(com.google.protobuf.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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.
      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Lists the Tensorboards that match the filter expression.
         
        string filter = 2;
        Specified by:
        getFilterBytes in interface ListTensorboardsRequestOrBuilder
        Returns:
        The bytes for filter.
      • setFilter

        public ListTensorboardsRequest.Builder setFilter​(String value)
         Lists the Tensorboards that match the filter expression.
         
        string filter = 2;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.
      • clearFilter

        public ListTensorboardsRequest.Builder clearFilter()
         Lists the Tensorboards that match the filter expression.
         
        string filter = 2;
        Returns:
        This builder for chaining.
      • setFilterBytes

        public ListTensorboardsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         Lists the Tensorboards 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 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;
        Specified by:
        getPageSize in interface ListTensorboardsRequestOrBuilder
        Returns:
        The pageSize.
      • setPageSize

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

        public String getPageToken()
         A page token, received from a previous
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         must match the call that provided the page token.
         
        string page_token = 4;
        Specified by:
        getPageToken in interface ListTensorboardsRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         A page token, received from a previous
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         must match the call that provided the page token.
         
        string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ListTensorboardsRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • setPageToken

        public ListTensorboardsRequest.Builder setPageToken​(String value)
         A page token, received from a previous
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         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 ListTensorboardsRequest.Builder clearPageToken()
         A page token, received from a previous
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         must match the call that provided the page token.
         
        string page_token = 4;
        Returns:
        This builder for chaining.
      • setPageTokenBytes

        public ListTensorboardsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         A page token, received from a previous
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [TensorboardService.ListTensorboards][google.cloud.aiplatform.v1beta1.TensorboardService.ListTensorboards]
         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.
      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         Field to use to sort the list.
         
        string order_by = 5;
        Specified by:
        getOrderByBytes in interface ListTensorboardsRequestOrBuilder
        Returns:
        The bytes for orderBy.
      • setOrderBy

        public ListTensorboardsRequest.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 ListTensorboardsRequest.Builder clearOrderBy()
         Field to use to sort the list.
         
        string order_by = 5;
        Returns:
        This builder for chaining.
      • setOrderByBytes

        public ListTensorboardsRequest.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 ListTensorboardsRequestOrBuilder
        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 ListTensorboardsRequestOrBuilder
        Returns:
        The readMask.
      • setReadMask

        public ListTensorboardsRequest.Builder setReadMask​(com.google.protobuf.FieldMask value)
         Mask specifying which fields to read.
         
        .google.protobuf.FieldMask read_mask = 6;
      • setReadMask

        public ListTensorboardsRequest.Builder setReadMask​(com.google.protobuf.FieldMask.Builder builderForValue)
         Mask specifying which fields to read.
         
        .google.protobuf.FieldMask read_mask = 6;
      • mergeReadMask

        public ListTensorboardsRequest.Builder mergeReadMask​(com.google.protobuf.FieldMask value)
         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;
      • setUnknownFields

        public final ListTensorboardsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>
      • mergeUnknownFields

        public final ListTensorboardsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListTensorboardsRequest.Builder>