com.google.cloud.resourcemanager.v3

Class SearchProjectsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.resourcemanager.v3.SearchProjectsRequest

All Implemented Interfaces:

SearchProjectsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class SearchProjectsRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchProjectsRequestOrBuilder

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

Protobuf type google.cloud.resourcemanager.v3.SearchProjectsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchProjectsRequest.Builder The request sent to the [SearchProjects][google.cloud.resourcemanager.v3.Projects.SearchProjects] method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	QUERY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SearchProjectsRequest	getDefaultInstance()
SearchProjectsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
com.google.protobuf.Parser<SearchProjectsRequest>	getParserForType()
String	getQuery() Optional.
com.google.protobuf.ByteString	getQueryBytes() Optional.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchProjectsRequest.Builder	newBuilder()
static SearchProjectsRequest.Builder	newBuilder(SearchProjectsRequest prototype)
SearchProjectsRequest.Builder	newBuilderForType()
protected SearchProjectsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchProjectsRequest	parseDelimitedFrom(InputStream input)
static SearchProjectsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchProjectsRequest	parseFrom(byte[] data)
static SearchProjectsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchProjectsRequest	parseFrom(ByteBuffer data)
static SearchProjectsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchProjectsRequest	parseFrom(com.google.protobuf.ByteString data)
static SearchProjectsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchProjectsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchProjectsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchProjectsRequest	parseFrom(InputStream input)
static SearchProjectsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchProjectsRequest>	parser()
SearchProjectsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchProjectsRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchProjectsRequest parseFrom(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchProjectsRequest parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchProjectsRequest parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchProjectsRequest parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchProjectsRequest parseFrom(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchProjectsRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static SearchProjectsRequest parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchProjectsRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchProjectsRequest parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static SearchProjectsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static SearchProjectsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public SearchProjectsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchProjectsRequest.Builder newBuilder()

newBuilder

public static SearchProjectsRequest.Builder newBuilder(SearchProjectsRequest prototype)

toBuilder

public SearchProjectsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchProjectsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchProjectsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchProjectsRequest> parser()

getParserForType

public com.google.protobuf.Parser<SearchProjectsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchProjectsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder