Class ListEndpointsRequest.Builder (1.15.0) 

public static final class ListEndpointsRequest.Builder extends GeneratedMessageV3.Builder<ListEndpointsRequest.Builder> implements ListEndpointsRequestOrBuilder

Request message for EndpointService.ListEndpoints.

Protobuf type google.cloud.vertexai.v1.ListEndpointsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListEndpointsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListEndpointsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

build()

public ListEndpointsRequest build()
Returns
Type Description
ListEndpointsRequest

buildPartial()

public ListEndpointsRequest buildPartial()
Returns
Type Description
ListEndpointsRequest

clear()

public ListEndpointsRequest.Builder clear()
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListEndpointsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

clearFilter()

public ListEndpointsRequest.Builder clearFilter()

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

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name.
  • display_name 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".

  • base_model_name only supports =.

    Some examples:

  • endpoint=1

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"

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

Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListEndpointsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

clearOrderBy()

public ListEndpointsRequest.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

    Example: display_name, create_time desc.

string order_by = 6;

Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

clearPageSize()

public ListEndpointsRequest.Builder clearPageSize()

Optional. The standard list page size.

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

Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

clearPageToken()

public ListEndpointsRequest.Builder clearPageToken()

Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

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

Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

clearParent()

public ListEndpointsRequest.Builder clearParent()

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

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

Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

clearReadMask()

public ListEndpointsRequest.Builder clearReadMask()

Optional. Mask specifying which fields to read.

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

Returns
Type Description
ListEndpointsRequest.Builder

clone()

public ListEndpointsRequest.Builder clone()
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListEndpointsRequest getDefaultInstanceForType()
Returns
Type Description
ListEndpointsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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.

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name.
  • display_name 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".

  • base_model_name only supports =.

    Some examples:

  • endpoint=1

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"

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

Returns
Type Description
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.

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name.
  • display_name 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".

  • base_model_name only supports =.

    Some examples:

  • endpoint=1

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"

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

Returns
Type Description
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

    Example: display_name, create_time desc.

string order_by = 6;

Returns
Type Description
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

    Example: display_name, create_time desc.

string order_by = 6;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The standard list page size.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
Type Description
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
Type Description
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
Type Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Optional. Mask specifying which fields to read.

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

Returns
Type Description
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Optional. Mask specifying which fields to read.

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

Returns
Type Description
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListEndpointsRequest other)

public ListEndpointsRequest.Builder mergeFrom(ListEndpointsRequest other)
Parameter
Name Description
other ListEndpointsRequest
Returns
Type Description
ListEndpointsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListEndpointsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEndpointsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListEndpointsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListEndpointsRequest.Builder mergeReadMask(FieldMask value)

Optional. Mask specifying which fields to read.

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

Parameter
Name Description
value FieldMask
Returns
Type Description
ListEndpointsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListEndpointsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListEndpointsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

setFilter(String value)

public ListEndpointsRequest.Builder setFilter(String value)

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

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name.
  • display_name 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".

  • base_model_name only supports =.

    Some examples:

  • endpoint=1

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListEndpointsRequest.Builder setFilterBytes(ByteString value)

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

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name.
  • display_name 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".

  • base_model_name only supports =.

    Some examples:

  • endpoint=1

  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListEndpointsRequest.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

    Example: display_name, create_time desc.

string order_by = 6;

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListEndpointsRequest.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

    Example: display_name, create_time desc.

string order_by = 6;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListEndpointsRequest.Builder setPageSize(int value)

Optional. The standard list page size.

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

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEndpointsRequest.Builder setPageToken(String value)

Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

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

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEndpointsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setParent(String value)

public ListEndpointsRequest.Builder setParent(String value)

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

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEndpointsRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListEndpointsRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListEndpointsRequest.Builder setReadMask(FieldMask value)

Optional. Mask specifying which fields to read.

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

Parameter
Name Description
value FieldMask
Returns
Type Description
ListEndpointsRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListEndpointsRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Optional. Mask specifying which fields to read.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListEndpointsRequest.Builder

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

public ListEndpointsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListEndpointsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListEndpointsRequest.Builder
Overrides