Class SearchProjectsRequest (1.17.0)

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
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchProjectsRequest getDefaultInstance()
Returns
TypeDescription
SearchProjectsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchProjectsRequest.Builder newBuilder()
Returns
TypeDescription
SearchProjectsRequest.Builder

newBuilder(SearchProjectsRequest prototype)

public static SearchProjectsRequest.Builder newBuilder(SearchProjectsRequest prototype)
Parameter
NameDescription
prototypeSearchProjectsRequest
Returns
TypeDescription
SearchProjectsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchProjectsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchProjectsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchProjectsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchProjectsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchProjectsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchProjectsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchProjectsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchProjectsRequest> parser()
Returns
TypeDescription
Parser<SearchProjectsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchProjectsRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchProjectsRequest

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pageToken.

getParserForType()

public Parser<SearchProjectsRequest> getParserForType()
Returns
TypeDescription
Parser<SearchProjectsRequest>
Overrides

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, the it will return results that match any of the fields. Some eligible fields are: `

FieldDescription
displayName, nameFilters by displayName.
parentProject's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id.
parent.typeParent'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:

QueryDescription
name:how*The project's name starts with "how".
name:HowlThe 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&nbsp;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];

Returns
TypeDescription
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: `

FieldDescription
displayName, nameFilters by displayName.
parentProject's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id.
parent.typeParent'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:

QueryDescription
name:how*The project's name starts with "how".
name:HowlThe 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&nbsp;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];

Returns
TypeDescription
ByteString

The bytes for query.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchProjectsRequest.Builder newBuilderForType()
Returns
TypeDescription
SearchProjectsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchProjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchProjectsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchProjectsRequest.Builder toBuilder()
Returns
TypeDescription
SearchProjectsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException