Class ListDatasetsRequest.Builder (3.19.0)

public static final class ListDatasetsRequest.Builder extends GeneratedMessageV3.Builder<ListDatasetsRequest.Builder> implements ListDatasetsRequestOrBuilder

Request message for DatasetService.ListDatasets.

Protobuf type google.cloud.aiplatform.v1.ListDatasetsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListDatasetsRequest build()
Returns
TypeDescription
ListDatasetsRequest

buildPartial()

public ListDatasetsRequest buildPartial()
Returns
TypeDescription
ListDatasetsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListDatasetsRequest.Builder clearFilter()

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • display_name: supports = and !=
  • metadata_schema_uri: supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key". Some examples:
  • displayName="myDisplayName"
  • labels.myKey="myValue"`

string filter = 2;

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListDatasetsRequest.Builder clearOrderBy()

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • display_name
  • create_time
  • update_time

string order_by = 6;

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

clearPageSize()

public ListDatasetsRequest.Builder clearPageSize()

The standard list page size.

int32 page_size = 3;

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

clearPageToken()

public ListDatasetsRequest.Builder clearPageToken()

The standard list page token.

string page_token = 4;

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

clearParent()

public ListDatasetsRequest.Builder clearParent()

Required. The name of the Dataset's parent resource. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

clearReadMask()

public ListDatasetsRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Returns
TypeDescription
ListDatasetsRequest.Builder

clone()

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

getDefaultInstanceForType()

public ListDatasetsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListDatasetsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • display_name: supports = and !=
  • metadata_schema_uri: supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key". Some examples:
  • displayName="myDisplayName"
  • labels.myKey="myValue"`

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • display_name: supports = and !=
  • metadata_schema_uri: supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key". Some examples:
  • displayName="myDisplayName"
  • labels.myKey="myValue"`

string filter = 2;

Returns
TypeDescription
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • display_name
  • create_time
  • update_time

string order_by = 6;

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • display_name
  • create_time
  • update_time

string order_by = 6;

Returns
TypeDescription
ByteString

The bytes for orderBy.

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.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The standard list page token.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The name of the Dataset's parent resource. 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 name of the Dataset's parent resource. 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(ListDatasetsRequest other)

public ListDatasetsRequest.Builder mergeFrom(ListDatasetsRequest other)
Parameter
NameDescription
otherListDatasetsRequest
Returns
TypeDescription
ListDatasetsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadMask(FieldMask value)

public ListDatasetsRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListDatasetsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListDatasetsRequest.Builder setFilter(String value)

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • display_name: supports = and !=
  • metadata_schema_uri: supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key". Some examples:
  • displayName="myDisplayName"
  • labels.myKey="myValue"`

string filter = 2;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListDatasetsRequest.Builder setFilterBytes(ByteString value)

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • display_name: supports = and !=
  • metadata_schema_uri: supports = and !=
  • labels supports general map functions that is:
    • labels.key=value - key:value equality
    • labels.key:* or labels:key - key existence
    • A key including a space must be quoted. labels."a key". Some examples:
  • displayName="myDisplayName"
  • labels.myKey="myValue"`

string filter = 2;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListDatasetsRequest.Builder setOrderBy(String value)

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • display_name
  • create_time
  • update_time

string order_by = 6;

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListDatasetsRequest.Builder setOrderByBytes(ByteString value)

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • display_name
  • create_time
  • update_time

string order_by = 6;

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListDatasetsRequest.Builder setPageSize(int value)

The standard list page size.

int32 page_size = 3;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListDatasetsRequest.Builder setPageToken(String value)

The standard list page token.

string page_token = 4;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDatasetsRequest.Builder setPageTokenBytes(ByteString value)

The standard list page token.

string page_token = 4;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListDatasetsRequest.Builder

This builder for chaining.

setParent(String value)

public ListDatasetsRequest.Builder setParent(String value)

Required. The name of the Dataset's parent resource. 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
ListDatasetsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListDatasetsRequest.Builder setParentBytes(ByteString value)

Required. The name of the Dataset's parent resource. 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
ListDatasetsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListDatasetsRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListDatasetsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListDatasetsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListDatasetsRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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