Interface ListMembershipsRequestOrBuilder (1.5.0)

public interface ListMembershipsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

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

  • Name is bar in project foo-proj and location global: name = "projects/foo-proj/locations/global/membership/bar"
  • Memberships that have a label called foo: labels.foo:*
  • Memberships that have a label called foo whose value is bar: labels.foo = bar
  • Memberships in the CREATING state: state = CREATING

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

Returns
TypeDescription
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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

  • Name is bar in project foo-proj and location global: name = "projects/foo-proj/locations/global/membership/bar"
  • Memberships that have a label called foo: labels.foo:*
  • Memberships that have a label called foo whose value is bar: labels.foo = bar
  • Memberships in the CREATING state: state = CREATING

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

Returns
TypeDescription
ByteString

The bytes for filter.

getOrderBy()

public abstract String getOrderBy()

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

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

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

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

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

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

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

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

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for parent.