com.google.cloud.resourcemanager.v3

Class SearchProjectsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

com.google.cloud.resourcemanager.v3.SearchProjectsRequest.Builder

All Implemented Interfaces:

SearchProjectsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchProjectsRequest

public static final class SearchProjectsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>
implements SearchProjectsRequestOrBuilder

 The request sent to the
 [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects]
 method.
 

Protobuf type google.cloud.resourcemanager.v3.SearchProjectsRequest

Method Summary

Modifier and Type	Method and Description
SearchProjectsRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchProjectsRequest	build()
SearchProjectsRequest	buildPartial()
SearchProjectsRequest.Builder	clear()
SearchProjectsRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchProjectsRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchProjectsRequest.Builder	clearPageSize() Optional.
SearchProjectsRequest.Builder	clearPageToken() Optional.
SearchProjectsRequest.Builder	clearQuery() Optional.
SearchProjectsRequest.Builder	clone()
SearchProjectsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getQuery() Optional.
com.google.protobuf.ByteString	getQueryBytes() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SearchProjectsRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchProjectsRequest.Builder	mergeFrom(com.google.protobuf.Message other)
SearchProjectsRequest.Builder	mergeFrom(SearchProjectsRequest other)
SearchProjectsRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchProjectsRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchProjectsRequest.Builder	setPageSize(int value) Optional.
SearchProjectsRequest.Builder	setPageToken(String value) Optional.
SearchProjectsRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) Optional.
SearchProjectsRequest.Builder	setQuery(String value) Optional.
SearchProjectsRequest.Builder	setQueryBytes(com.google.protobuf.ByteString value) Optional.
SearchProjectsRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchProjectsRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

clear

public SearchProjectsRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

getDefaultInstanceForType

public SearchProjectsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchProjectsRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SearchProjectsRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SearchProjectsRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

setField

public SearchProjectsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

clearField

public SearchProjectsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

clearOneof

public SearchProjectsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

setRepeatedField

public SearchProjectsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

addRepeatedField

public SearchProjectsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

mergeFrom

public SearchProjectsRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchProjectsRequest.Builder>

mergeFrom

public SearchProjectsRequest.Builder mergeFrom(SearchProjectsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

mergeFrom

public SearchProjectsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchProjectsRequest.Builder>

Throws:

IOException

getQuery

public 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];

Specified by:

getQuery in interface SearchProjectsRequestOrBuilder

Returns:

The query.

getQueryBytes

public 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];

Specified by:

getQueryBytes in interface SearchProjectsRequestOrBuilder

Returns:

The bytes for query.

setQuery

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];

Parameters:

value - The query to set.

Returns:

This builder for chaining.

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];

Returns:

This builder for chaining.

setQueryBytes

public SearchProjectsRequest.Builder setQueryBytes(com.google.protobuf.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];

Parameters:

value - The bytes for query to set.

Returns:

This builder for chaining.

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];

Specified by:

getPageToken in interface SearchProjectsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public 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];

Specified by:

getPageTokenBytes in interface SearchProjectsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

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];

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

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];

Returns:

This builder for chaining.

setPageTokenBytes

public SearchProjectsRequest.Builder setPageTokenBytes(com.google.protobuf.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];

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

getPageSize

public 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];

Specified by:

getPageSize in interface SearchProjectsRequestOrBuilder

Returns:

The pageSize.

setPageSize

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];

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

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];

Returns:

This builder for chaining.

setUnknownFields

public final SearchProjectsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>

mergeUnknownFields

public final SearchProjectsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchProjectsRequest.Builder>