com.google.cloud.resourcemanager.v3

Interface SearchProjectsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchProjectsRequest, SearchProjectsRequest.Builder

public interface SearchProjectsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getQuery() Optional.
com.google.protobuf.ByteString	getQueryBytes() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getQuery

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:

The query.

getQueryBytes

com.google.protobuf.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:

The bytes for query.

getPageToken

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:

The pageToken.

getPageTokenBytes

com.google.protobuf.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:

The bytes for pageToken.

getPageSize

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:

The pageSize.