Package com.google.cloud.aiplatform.v1

Interface ListTrainingPipelinesRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      The standard list filter.
      com.google.protobuf.ByteString getFilterBytes()
      The standard list filter.
      int getPageSize()
      The standard list page size.
      String getPageToken()
      The standard list page token.
      com.google.protobuf.ByteString getPageTokenBytes()
      The standard list page token.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      com.google.protobuf.FieldMask getReadMask()
      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.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

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

      • getParentBytes

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

      • getFilter

        String getFilter()
         The standard list filter.

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard.
   * `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="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"`
   * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"`
   * `NOT display_name="my_pipeline"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `training_task_definition:"*automl_text_classification*"`
        string filter = 2;
        Returns:
        The filter.

      • getFilterBytes

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

 Supported fields:

   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
   * `state` supports `=`, `!=` comparisons.
   * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard.
   * `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="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"`
   * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"`
   * `NOT display_name="my_pipeline"`
   * `create_time>"2021-05-18T00:00:00Z"`
   * `training_task_definition:"*automl_text_classification*"`
        string filter = 2;
        Returns:
        The bytes for filter.

      • getPageSize

        int getPageSize()
         The standard list page size.
        int32 page_size = 3;
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         The standard list page token.
 Typically obtained via
 [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token]
 of the previous
 [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]
 call.
        string page_token = 4;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         The standard list page token.
 Typically obtained via
 [ListTrainingPipelinesResponse.next_page_token][google.cloud.aiplatform.v1.ListTrainingPipelinesResponse.next_page_token]
 of the previous
 [PipelineService.ListTrainingPipelines][google.cloud.aiplatform.v1.PipelineService.ListTrainingPipelines]
 call.
        string page_token = 4;
        Returns:
        The bytes for pageToken.

      • hasReadMask

        boolean hasReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;
        Returns:
        Whether the readMask field is set.

      • getReadMask

        com.google.protobuf.FieldMask getReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;
        Returns:
        The readMask.

      • getReadMaskOrBuilder

        com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;