public final class ListEndpointsRequest extends GeneratedMessageV3 implements ListEndpointsRequestOrBuilder
Request message for EndpointService.ListEndpoints.
Protobuf type google.cloud.aiplatform.v1.ListEndpointsRequest
Static Fields
public static final int FILTER_FIELD_NUMBER
Field Value
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
public static final int PARENT_FIELD_NUMBER
Field Value
public static final int READ_MASK_FIELD_NUMBER
Field Value
Static Methods
public static ListEndpointsRequest getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ListEndpointsRequest.Builder newBuilder()
Returns
public static ListEndpointsRequest.Builder newBuilder(ListEndpointsRequest prototype)
Parameter
Returns
public static ListEndpointsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListEndpointsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListEndpointsRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static ListEndpointsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListEndpointsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ListEndpointsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListEndpointsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListEndpointsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListEndpointsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListEndpointsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListEndpointsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ListEndpointsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ListEndpointsRequest> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public ListEndpointsRequest getDefaultInstanceForType()
Returns
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"
.
Some examples:
- endpoint=1
- displayName="myDisplayName"
- labels.myKey="myValue"`
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
String | The filter.
|
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"
.
Some examples:
- endpoint=1
- displayName="myDisplayName"
- labels.myKey="myValue"`
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
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.
|
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
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
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.
|
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
public Parser<ListEndpointsRequest> getParserForType()
Returns
Overrides
public FieldMask getReadMask()
Optional. Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
public FieldMaskOrBuilder getReadMaskOrBuilder()
Optional. Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ListEndpointsRequest.Builder newBuilderForType()
Returns
protected ListEndpointsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ListEndpointsRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions