ListIndexEndpointsRequest.Builder (proto-google-cloud-aiplatform-v1 3.86.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<ListIndexEndpointsRequest.Builder>
    - - com.google.cloud.aiplatform.v1.ListIndexEndpointsRequest.Builder

All Implemented Interfaces:

ListIndexEndpointsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListIndexEndpointsRequest
```
public static final class ListIndexEndpointsRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListIndexEndpointsRequest.Builder>
implements ListIndexEndpointsRequestOrBuilder
```
```
 Request message for
 [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
 
```
Protobuf type google.cloud.aiplatform.v1.ListIndexEndpointsRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListIndexEndpointsRequest`	`build()`
`ListIndexEndpointsRequest`	`buildPartial()`
`ListIndexEndpointsRequest.Builder`	`clear()`
`ListIndexEndpointsRequest.Builder`	`clearFilter()` Optional.
`ListIndexEndpointsRequest.Builder`	`clearPageSize()` Optional.
`ListIndexEndpointsRequest.Builder`	`clearPageToken()` Optional.
`ListIndexEndpointsRequest.Builder`	`clearParent()` Required.
`ListIndexEndpointsRequest.Builder`	`clearReadMask()` Optional.
`ListIndexEndpointsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getFilter()` Optional.
`com.google.protobuf.ByteString`	`getFilterBytes()` Optional.
`int`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` Optional.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`com.google.protobuf.FieldMask`	`getReadMask()` Optional.
`com.google.protobuf.FieldMask.Builder`	`getReadMaskBuilder()` Optional.
`com.google.protobuf.FieldMaskOrBuilder`	`getReadMaskOrBuilder()` Optional.
`boolean`	`hasReadMask()` Optional.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ListIndexEndpointsRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ListIndexEndpointsRequest.Builder`	`mergeFrom(ListIndexEndpointsRequest other)`
`ListIndexEndpointsRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ListIndexEndpointsRequest.Builder`	`mergeReadMask(com.google.protobuf.FieldMask value)` Optional.
`ListIndexEndpointsRequest.Builder`	`setFilter(String value)` Optional.
`ListIndexEndpointsRequest.Builder`	`setFilterBytes(com.google.protobuf.ByteString value)` Optional.
`ListIndexEndpointsRequest.Builder`	`setPageSize(int value)` Optional.
`ListIndexEndpointsRequest.Builder`	`setPageToken(String value)` Optional.
`ListIndexEndpointsRequest.Builder`	`setPageTokenBytes(com.google.protobuf.ByteString value)` Optional.
`ListIndexEndpointsRequest.Builder`	`setParent(String value)` Required.
`ListIndexEndpointsRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`ListIndexEndpointsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)` Optional.
`ListIndexEndpointsRequest.Builder`	`setReadMask(com.google.protobuf.FieldMask value)` Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListIndexEndpointsRequest.Builder>

clear
```
public ListIndexEndpointsRequest.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<ListIndexEndpointsRequest.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListIndexEndpointsRequest.Builder>

getDefaultInstanceForType
```
public ListIndexEndpointsRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public ListIndexEndpointsRequest build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public ListIndexEndpointsRequest buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom
```
public ListIndexEndpointsRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListIndexEndpointsRequest.Builder>

mergeFrom

public ListIndexEndpointsRequest.Builder mergeFrom(ListIndexEndpointsRequest other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListIndexEndpointsRequest.Builder>

mergeFrom

public ListIndexEndpointsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Specified by:: mergeFrom in interface com.google.protobuf.Message.Builder
Specified by:: mergeFrom in interface com.google.protobuf.MessageLite.Builder
Overrides:: mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListIndexEndpointsRequest.Builder>
Throws:: IOException

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

getParent in interface ListIndexEndpointsRequestOrBuilder

Returns:

The parent.

getParentBytes
```
public com.google.protobuf.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) = { ... }
Specified by:

getParentBytes in interface ListIndexEndpointsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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

Parameters:: value - The parent to set.
Returns:: 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:: This builder for chaining.

setParentBytes

public ListIndexEndpointsRequest.Builder setParentBytes(com.google.protobuf.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) = { ... }

Parameters:: value - The bytes for parent to set.
Returns:: This builder for chaining.

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][google.cloud.aiplatform.v1.IndexEndpoint.name].
 * `display_name` supports =, != and regex()
 (uses [re2](https://github.com/google/re2/wiki/Syntax) 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];

Specified by:: getFilter in interface ListIndexEndpointsRequestOrBuilder
Returns:: The filter.

getFilterBytes

public com.google.protobuf.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][google.cloud.aiplatform.v1.IndexEndpoint.name].
 * `display_name` supports =, != and regex()
 (uses [re2](https://github.com/google/re2/wiki/Syntax) 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];

Specified by:: getFilterBytes in interface ListIndexEndpointsRequestOrBuilder
Returns:: The bytes for filter.

setFilter

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][google.cloud.aiplatform.v1.IndexEndpoint.name].
 * `display_name` supports =, != and regex()
 (uses [re2](https://github.com/google/re2/wiki/Syntax) 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];

Parameters:: value - The filter to set.
Returns:: This builder for chaining.

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][google.cloud.aiplatform.v1.IndexEndpoint.name].
 * `display_name` supports =, != and regex()
 (uses [re2](https://github.com/google/re2/wiki/Syntax) 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:: This builder for chaining.

setFilterBytes

public ListIndexEndpointsRequest.Builder setFilterBytes(com.google.protobuf.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][google.cloud.aiplatform.v1.IndexEndpoint.name].
 * `display_name` supports =, != and regex()
 (uses [re2](https://github.com/google/re2/wiki/Syntax) 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];

Parameters:: value - The bytes for filter to set.
Returns:: This builder for chaining.

getPageSize
```
public int getPageSize()
```
```
 Optional. The standard list page size.
 
```
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getPageSize in interface ListIndexEndpointsRequestOrBuilder

Returns:

The pageSize.

setPageSize
```
public ListIndexEndpointsRequest.Builder setPageSize(int value)
```
```
 Optional. The standard list page size.
 
```
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize
```
public ListIndexEndpointsRequest.Builder clearPageSize()
```
```
 Optional. The standard list page size.
 
```
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns:

This builder for chaining.