Interface SearchProjectsRequestOrBuilder (1.31.0)

Version 1.31.0

• 1.55.0 (latest)
• 1.54.0
• 1.53.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.6
• 1.4.0
• 1.3.2
• 1.2.12

public interface SearchProjectsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of projects to return in the response. The server can return fewer projects than requested. If unspecified, server picks an appropriate default.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

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

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

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

Returns
Type	Description
ByteString	The bytes for pageToken.

getQuery()

public abstract String getQuery()

Optional. A query string for searching for projects that the caller has resourcemanager.projects.get permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are:

• displayName, name: Filters by displayName.
• parent: Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.
• parent.type: Parent's type: folder or organization.
• parent.id: Parent's id number (for example: 123).
• id, projectId: Filters by projectId.
• state, lifecycleState: Filters by state.
• labels: Filters by label name or value.

• labels.<key> (where <key> is the name of a label): Filters by label name.

  Search expressions are case insensitive.

  Some examples queries:

• name:how*: The project's name starts with "how".

• name:Howl: The project's name is Howl or howl.
• name:HOWL: Equivalent to above.
• NAME:howl: Equivalent to above.
• labels.color:*: The project has the label color.
• labels.color:red: The project's label color has the value red.

• labels.color:red labels.size:big: The project's label color has the value red or its label size has the value big.

  If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

Optional. A query string for searching for projects that the caller has resourcemanager.projects.get permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are:

• displayName, name: Filters by displayName.
• parent: Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.
• parent.type: Parent's type: folder or organization.
• parent.id: Parent's id number (for example: 123).
• id, projectId: Filters by projectId.
• state, lifecycleState: Filters by state.
• labels: Filters by label name or value.

• labels.<key> (where <key> is the name of a label): Filters by label name.

  Search expressions are case insensitive.

  Some examples queries:

• name:how*: The project's name starts with "how".

• name:Howl: The project's name is Howl or howl.
• name:HOWL: Equivalent to above.
• NAME:howl: Equivalent to above.
• labels.color:*: The project has the label color.
• labels.color:red: The project's label color has the value red.

• labels.color:red labels.size:big: The project's label color has the value red or its label size has the value big.

  If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for query.