public static final class SearchProjectsRequest.Builder extends GeneratedMessageV3.Builder<SearchProjectsRequest.Builder> implements SearchProjectsRequestOrBuilder
The request sent to the
SearchProjects
method.
Protobuf type google.cloud.resourcemanager.v3.SearchProjectsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchProjectsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public SearchProjectsRequest build()
buildPartial()
public SearchProjectsRequest buildPartial()
clear()
public SearchProjectsRequest.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public SearchProjectsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchProjectsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearPageSize()
public SearchProjectsRequest.Builder clearPageSize()
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];
clearPageToken()
public SearchProjectsRequest.Builder clearPageToken()
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];
clearQuery()
public SearchProjectsRequest.Builder clearQuery()
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];
clone()
public SearchProjectsRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public SearchProjectsRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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 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 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()
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 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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(SearchProjectsRequest other)
public SearchProjectsRequest.Builder mergeFrom(SearchProjectsRequest other)
public SearchProjectsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public SearchProjectsRequest.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchProjectsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public SearchProjectsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setPageSize(int value)
public SearchProjectsRequest.Builder setPageSize(int value)
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];
| Parameter |
|---|
| Name | Description |
value | int
The pageSize to set.
|
setPageToken(String value)
public SearchProjectsRequest.Builder setPageToken(String value)
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];
| Parameter |
|---|
| Name | Description |
value | String
The pageToken to set.
|
setPageTokenBytes(ByteString value)
public SearchProjectsRequest.Builder setPageTokenBytes(ByteString value)
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];
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for pageToken to set.
|
setQuery(String value)
public SearchProjectsRequest.Builder setQuery(String value)
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];
| Parameter |
|---|
| Name | Description |
value | String
The query to set.
|
setQueryBytes(ByteString value)
public SearchProjectsRequest.Builder setQueryBytes(ByteString value)
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];
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for query to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchProjectsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchProjectsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
