Class ListEndpointsRequest (1.2.0) 

public final class ListEndpointsRequest extends GeneratedMessageV3 implements ListEndpointsRequestOrBuilder

Request message for EndpointService.ListEndpoints.

Protobuf type google.cloud.vertexai.v1.ListEndpointsRequest

Inheritance

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

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListEndpointsRequest getDefaultInstance()
Returns
Type Description
ListEndpointsRequest

getDescriptor()

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

newBuilder()

public static ListEndpointsRequest.Builder newBuilder()
Returns
Type Description
ListEndpointsRequest.Builder

newBuilder(ListEndpointsRequest prototype)

public static ListEndpointsRequest.Builder newBuilder(ListEndpointsRequest prototype)
Parameter
Name Description
prototype ListEndpointsRequest
Returns
Type Description
ListEndpointsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListEndpointsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListEndpointsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListEndpointsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListEndpointsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListEndpointsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListEndpointsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListEndpointsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListEndpointsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListEndpointsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListEndpointsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListEndpointsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListEndpointsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEndpointsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListEndpointsRequest> parser()
Returns
Type Description
Parser<ListEndpointsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListEndpointsRequest getDefaultInstanceForType()
Returns
Type Description
ListEndpointsRequest

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.

getParserForType()

public Parser<ListEndpointsRequest> getParserForType()
Returns
Type Description
Parser<ListEndpointsRequest>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListEndpointsRequest.Builder newBuilderForType()
Returns
Type Description
ListEndpointsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListEndpointsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListEndpointsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListEndpointsRequest.Builder toBuilder()
Returns
Type Description
ListEndpointsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException