Class ListTrialsRequest.Builder

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

    public static final class ListTrialsRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<ListTrialsRequest.Builder>
    implements ListTrialsRequestOrBuilder
     Request message for
     [VizierService.ListTrials][google.cloud.aiplatform.v1.VizierService.ListTrials].
     
    Protobuf type google.cloud.aiplatform.v1.ListTrialsRequest
    • 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<ListTrialsRequest.Builder>
      • clear

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

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

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

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

        public ListTrialsRequest.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<ListTrialsRequest.Builder>
      • setField

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

        public ListTrialsRequest.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<ListTrialsRequest.Builder>
      • clearOneof

        public ListTrialsRequest.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<ListTrialsRequest.Builder>
      • setRepeatedField

        public ListTrialsRequest.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<ListTrialsRequest.Builder>
      • addRepeatedField

        public ListTrialsRequest.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<ListTrialsRequest.Builder>
      • mergeFrom

        public ListTrialsRequest.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<ListTrialsRequest.Builder>
      • isInitialized

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

        public ListTrialsRequest.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<ListTrialsRequest.Builder>
        Throws:
        IOException
      • getParent

        public String getParent()
         Required. The resource name of the Study to list the Trial from.
         Format: `projects/{project}/locations/{location}/studies/{study}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListTrialsRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the Study to list the Trial from.
         Format: `projects/{project}/locations/{location}/studies/{study}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListTrialsRequestOrBuilder
        Returns:
        The bytes for parent.
      • setParent

        public ListTrialsRequest.Builder setParent​(String value)
         Required. The resource name of the Study to list the Trial from.
         Format: `projects/{project}/locations/{location}/studies/{study}`
         
        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 ListTrialsRequest.Builder clearParent()
         Required. The resource name of the Study to list the Trial from.
         Format: `projects/{project}/locations/{location}/studies/{study}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setParentBytes

        public ListTrialsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the Study to list the Trial from.
         Format: `projects/{project}/locations/{location}/studies/{study}`
         
        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.
      • getPageToken

        public String getPageToken()
         Optional. A page token to request the next page of results.
         If unspecified, there are no subsequent pages.
         
        string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface ListTrialsRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. A page token to request the next page of results.
         If unspecified, there are no subsequent pages.
         
        string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface ListTrialsRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • setPageToken

        public ListTrialsRequest.Builder setPageToken​(String value)
         Optional. A page token to request the next page of results.
         If unspecified, there are no subsequent pages.
         
        string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.
      • clearPageToken

        public ListTrialsRequest.Builder clearPageToken()
         Optional. A page token to request the next page of results.
         If unspecified, there are no subsequent pages.
         
        string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setPageTokenBytes

        public ListTrialsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Optional. A page token to request the next page of results.
         If unspecified, there are no subsequent pages.
         
        string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.
      • getPageSize

        public int getPageSize()
         Optional. The number of Trials to retrieve per "page" of results.
         If unspecified, the service will pick an appropriate default.
         
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface ListTrialsRequestOrBuilder
        Returns:
        The pageSize.
      • setPageSize

        public ListTrialsRequest.Builder setPageSize​(int value)
         Optional. The number of Trials to retrieve per "page" of results.
         If unspecified, the service will pick an appropriate default.
         
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.
      • clearPageSize

        public ListTrialsRequest.Builder clearPageSize()
         Optional. The number of Trials to retrieve per "page" of results.
         If unspecified, the service will pick an appropriate default.
         
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final ListTrialsRequest.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<ListTrialsRequest.Builder>
      • mergeUnknownFields

        public final ListTrialsRequest.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<ListTrialsRequest.Builder>