Interface ListFeaturesRequestOrBuilder (1.85.0) 

public interface ListFeaturesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Examples:

  • Feature with the name "servicemesh" in project "foo-proj":

    name = "projects/foo-proj/locations/global/features/servicemesh"

  • Features that have a label called foo:

    labels.foo:*

  • Features that have a label called foo whose value is bar:

    labels.foo = bar

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Examples:

  • Feature with the name "servicemesh" in project "foo-proj":

    name = "projects/foo-proj/locations/global/features/servicemesh"

  • Features that have a label called foo:

    labels.foo:*

  • Features that have a label called foo whose value is bar:

    labels.foo = bar

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public abstract String getOrderBy()

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

string order_by = 5;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

string order_by = 5;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

When requesting a 'page' of resources, page_size specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Token returned by previous call to ListFeatures which specifies the position in the list from where to continue listing the resources.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Token returned by previous call to ListFeatures which specifies the position in the list from where to continue listing the resources.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The parent (project and location) where the Features will be listed. Specified in the format projects/*/locations/*.

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

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent (project and location) where the Features will be listed. Specified in the format projects/*/locations/*.

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

Returns
Type Description
ByteString

The bytes for parent.

getReturnPartialSuccess()

public abstract boolean getReturnPartialSuccess()

Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.

bool return_partial_success = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The returnPartialSuccess.