Class ListTrainingPipelinesRequest.Builder (3.35.0)

public static final class ListTrainingPipelinesRequest.Builder extends GeneratedMessageV3.Builder<ListTrainingPipelinesRequest.Builder> implements ListTrainingPipelinesRequestOrBuilder

Request message for PipelineService.ListTrainingPipelines.

Protobuf type google.cloud.aiplatform.v1.ListTrainingPipelinesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTrainingPipelinesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

build()

public ListTrainingPipelinesRequest build()
Returns
TypeDescription
ListTrainingPipelinesRequest

buildPartial()

public ListTrainingPipelinesRequest buildPartial()
Returns
TypeDescription
ListTrainingPipelinesRequest

clear()

public ListTrainingPipelinesRequest.Builder clear()
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListTrainingPipelinesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

clearFilter()

public ListTrainingPipelinesRequest.Builder clearFilter()

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
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTrainingPipelinesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

clearPageSize()

public ListTrainingPipelinesRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

clearPageToken()

public ListTrainingPipelinesRequest.Builder clearPageToken()

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

string page_token = 4;

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

clearParent()

public ListTrainingPipelinesRequest.Builder clearParent()

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
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

clearReadMask()

public ListTrainingPipelinesRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

clone()

public ListTrainingPipelinesRequest.Builder clone()
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListTrainingPipelinesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListTrainingPipelinesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public 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
TypeDescription
String

The filter.

getFilterBytes()

public 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
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

The standard list page size.

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

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

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public 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
TypeDescription
String

The parent.

getParentBytes()

public 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
TypeDescription
ByteString

The bytes for parent.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListTrainingPipelinesRequest other)

public ListTrainingPipelinesRequest.Builder mergeFrom(ListTrainingPipelinesRequest other)
Parameter
NameDescription
otherListTrainingPipelinesRequest
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListTrainingPipelinesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListTrainingPipelinesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListTrainingPipelinesRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListTrainingPipelinesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListTrainingPipelinesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

setFilter(String value)

public ListTrainingPipelinesRequest.Builder setFilter(String value)

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;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListTrainingPipelinesRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListTrainingPipelinesRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTrainingPipelinesRequest.Builder setPageToken(String value)

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

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTrainingPipelinesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

setParent(String value)

public ListTrainingPipelinesRequest.Builder setParent(String value)

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) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTrainingPipelinesRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListTrainingPipelinesRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListTrainingPipelinesRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListTrainingPipelinesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListTrainingPipelinesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListTrainingPipelinesRequest.Builder
Overrides