Google Cloud Ai Platform V1 Client - Class ListTrainingPipelinesRequest (0.10.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListTrainingPipelinesRequest.

Request message for PipelineService.ListTrainingPipelines.

Generated from protobuf message google.cloud.aiplatform.v1.ListTrainingPipelinesRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the Location to list the TrainingPipelines from. Format: projects/{project}/locations/{location}

↳ filter string

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*"`

↳ page_size int

The standard list page size.

↳ page_token string

The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.

↳ read_mask Google\Protobuf\FieldMask

Mask specifying which fields to read.

getParent

Required. The resource name of the Location to list the TrainingPipelines from.

Format: projects/{project}/locations/{location}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

Required. The resource name of the Location to list the TrainingPipelines from.

Format: projects/{project}/locations/{location}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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*"

Generated from protobuf field string filter = 2;

Returns
TypeDescription
string

setFilter

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*"

Generated from protobuf field string filter = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The standard list page size.

Generated from protobuf field int32 page_size = 3;

Returns
TypeDescription
int

setPageSize

The standard list page size.

Generated from protobuf field int32 page_size = 3;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The standard list page token.

Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.

Generated from protobuf field string page_token = 4;

Returns
TypeDescription
string

setPageToken

The standard list page token.

Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.

Generated from protobuf field string page_token = 4;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Mask specifying which fields to read.

Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Generated from protobuf field .google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this