public final class SearchProjectsRequest extends GeneratedMessageV3 implements SearchProjectsRequestOrBuilder
The request sent to the
SearchProjects
method.
Protobuf type google.cloud.resourcemanager.v3.SearchProjectsRequest
Static Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchProjectsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchProjectsRequest.Builder newBuilder()
Returns
newBuilder(SearchProjectsRequest prototype)
public static SearchProjectsRequest.Builder newBuilder(SearchProjectsRequest prototype)
Parameter
Returns
public static SearchProjectsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchProjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchProjectsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchProjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchProjectsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchProjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchProjectsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchProjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchProjectsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchProjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchProjectsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchProjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchProjectsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SearchProjectsRequest getDefaultInstanceForType()
Returns
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];
| Type | Description |
| int | The pageSize.
|
getPageToken()
public 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];
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public 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];
getParserForType()
public Parser<SearchProjectsRequest> getParserForType()
Returns
Overrides
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, the it will return results that match any of the
fields. Some eligible fields are:
`
| Field | Description |
|---|
| 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:
| Query | Description |
|---|
| 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 and 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];
| Type | Description |
| String | The query.
|
getQueryBytes()
public 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, the it will return results that match any of the
fields. Some eligible fields are:
`
| Field | Description |
|---|
| 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:
| Query | Description |
|---|
| 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 and 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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchProjectsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchProjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchProjectsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
