Class ListIndexEndpointsRequest.Builder (3.16.0)

public static final class ListIndexEndpointsRequest.Builder extends GeneratedMessageV3.Builder<ListIndexEndpointsRequest.Builder> implements ListIndexEndpointsRequestOrBuilder

Request message for IndexEndpointService.ListIndexEndpoints.

Protobuf type google.cloud.aiplatform.v1beta1.ListIndexEndpointsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListIndexEndpointsRequest build()
Returns
TypeDescription
ListIndexEndpointsRequest

buildPartial()

public ListIndexEndpointsRequest buildPartial()
Returns
TypeDescription
ListIndexEndpointsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListIndexEndpointsRequest.Builder clearFilter()

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

  • index_endpoint supports = and !=. index_endpoint represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename.
  • display_name supports =, != and regex() (uses re2 syntax)
  • 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:
  • index_endpoint="1"
  • display_name="myDisplayName"
  • regex(display_name, "^A") -> The display name starts with an A.
  • labels.myKey="myValue"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListIndexEndpointsRequest.Builder clearPageSize()

Optional. The standard list page size.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

clearPageToken()

public ListIndexEndpointsRequest.Builder clearPageToken()

Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

clearParent()

public ListIndexEndpointsRequest.Builder clearParent()

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

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

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

clearReadMask()

public ListIndexEndpointsRequest.Builder clearReadMask()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

clone()

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

getDefaultInstanceForType()

public ListIndexEndpointsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListIndexEndpointsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

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

  • index_endpoint supports = and !=. index_endpoint represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename.
  • display_name supports =, != and regex() (uses re2 syntax)
  • 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:
  • index_endpoint="1"
  • display_name="myDisplayName"
  • regex(display_name, "^A") -> The display name starts with an A.
  • labels.myKey="myValue"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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

  • index_endpoint supports = and !=. index_endpoint represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename.
  • display_name supports =, != and regex() (uses re2 syntax)
  • 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:
  • index_endpoint="1"
  • display_name="myDisplayName"
  • regex(display_name, "^A") -> The display name starts with an A.
  • labels.myKey="myValue"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The standard list page size.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the Location from which to list the IndexEndpoints. 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 from which to list the IndexEndpoints. 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()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

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(ListIndexEndpointsRequest other)

public ListIndexEndpointsRequest.Builder mergeFrom(ListIndexEndpointsRequest other)
Parameter
NameDescription
otherListIndexEndpointsRequest
Returns
TypeDescription
ListIndexEndpointsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeReadMask(FieldMask value)

public ListIndexEndpointsRequest.Builder mergeReadMask(FieldMask value)

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListIndexEndpointsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListIndexEndpointsRequest.Builder setFilter(String value)

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

  • index_endpoint supports = and !=. index_endpoint represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename.
  • display_name supports =, != and regex() (uses re2 syntax)
  • 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:
  • index_endpoint="1"
  • display_name="myDisplayName"
  • regex(display_name, "^A") -> The display name starts with an A.
  • labels.myKey="myValue"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListIndexEndpointsRequest.Builder setFilterBytes(ByteString value)

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

  • index_endpoint supports = and !=. index_endpoint represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename.
  • display_name supports =, != and regex() (uses re2 syntax)
  • 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:
  • index_endpoint="1"
  • display_name="myDisplayName"
  • regex(display_name, "^A") -> The display name starts with an A.
  • labels.myKey="myValue"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListIndexEndpointsRequest.Builder setPageSize(int value)

Optional. The standard list page size.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListIndexEndpointsRequest.Builder setPageToken(String value)

Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListIndexEndpointsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListIndexEndpointsRequest.Builder

This builder for chaining.

setParent(String value)

public ListIndexEndpointsRequest.Builder setParent(String value)

Required. The resource name of the Location from which to list the IndexEndpoints. 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
ListIndexEndpointsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListIndexEndpointsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Location from which to list the IndexEndpoints. 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
ListIndexEndpointsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListIndexEndpointsRequest.Builder setReadMask(FieldMask value)

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
ListIndexEndpointsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListIndexEndpointsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ListIndexEndpointsRequest.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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