Interface ListPropertiesRequestOrBuilder (0.55.0)

Version 0.55.0

• 0.65.0 (latest)
• 0.64.0
• 0.63.0
• 0.62.0
• 0.61.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0

public interface ListPropertiesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:

`

Filter	Description
parent:accounts/123	The account with account id: 123.
parent:properties/123	The property with property id: 123.
ancestor:accounts/123	The account with account id: 123.
firebase_project:project-id	The firebase project with id: project-id.
firebase_project:123	The firebase project with number: 123.

`

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:

`

Filter	Description
parent:accounts/123	The account with account id: 123.
parent:properties/123	The property with property id: 123.
ancestor:accounts/123	The account with account id: 123.
firebase_project:project-id	The firebase project with id: project-id.
firebase_project:123	The firebase project with number: 123.

`

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int getPageSize()

The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

int32 page_size = 2;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

A page token, received from a previous ListProperties call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProperties must match the call that provided the page token.

string page_token = 3;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

A page token, received from a previous ListProperties call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProperties must match the call that provided the page token.

string page_token = 3;

Returns
Type	Description
ByteString	The bytes for pageToken.

getShowDeleted()

public abstract boolean getShowDeleted()

Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

bool show_deleted = 4;

Returns
Type	Description
boolean	The showDeleted.