Package com.google.cloud.aiplatform.v1

Class ListHyperparameterTuningJobsRequest.Builder

    • 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<ListHyperparameterTuningJobsRequest.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<ListHyperparameterTuningJobsRequest.Builder>

      • getDefaultInstanceForType

        public ListHyperparameterTuningJobsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • isInitialized

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

      • getParent

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

      • getParentBytes

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

      • setParent

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

      • setParentBytes

        public ListHyperparameterTuningJobsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the Location to list the
 HyperparameterTuningJobs from. 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.

      • getFilter

        public String getFilter()
         The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
        string filter = 2;
        Specified by:
        getFilter in interface ListHyperparameterTuningJobsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
        string filter = 2;
        Specified by:
        getFilterBytes in interface ListHyperparameterTuningJobsRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public ListHyperparameterTuningJobsRequest.Builder setFilter​(String value)
         The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
        string filter = 2;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ListHyperparameterTuningJobsRequest.Builder clearFilter()
         The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
        string filter = 2;
        Returns:
        This builder for chaining.

      • setFilterBytes

        public ListHyperparameterTuningJobsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     `create_time` must be in RFC 3339 format.
   * `labels` supports general map functions that is:
     `labels.key=value` - key:value equality
     `labels.key:* - key existence

 Some examples of using the filter are:

   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
   * `NOT display_name="my_job"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `labels.keyA=valueA`
   * `labels.keyB:*`
        string filter = 2;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • setPageSize

        public ListHyperparameterTuningJobsRequest.Builder setPageSize​(int value)
         The standard list page size.
        int32 page_size = 3;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • getPageToken

        public String getPageToken()
         The standard list page token.
 Typically obtained via
 [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
 of the previous
 [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
 call.
        string page_token = 4;
        Specified by:
        getPageToken in interface ListHyperparameterTuningJobsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The standard list page token.
 Typically obtained via
 [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
 of the previous
 [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
 call.
        string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ListHyperparameterTuningJobsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public ListHyperparameterTuningJobsRequest.Builder setPageToken​(String value)
         The standard list page token.
 Typically obtained via
 [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
 of the previous
 [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
 call.
        string page_token = 4;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListHyperparameterTuningJobsRequest.Builder clearPageToken()
         The standard list page token.
 Typically obtained via
 [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
 of the previous
 [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
 call.
        string page_token = 4;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public ListHyperparameterTuningJobsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         The standard list page token.
 Typically obtained via
 [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
 of the previous
 [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
 call.
        string page_token = 4;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • setReadMask

        public ListHyperparameterTuningJobsRequest.Builder setReadMask​(com.google.protobuf.FieldMask.Builder builderForValue)
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;

      • getReadMaskBuilder

        public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;