Class SearchProjectsRequest (1.57.0) 

public final class SearchProjectsRequest extends GeneratedMessageV3 implements SearchProjectsRequestOrBuilder

The request sent to the SearchProjects method.

Protobuf type google.cloud.resourcemanager.v3.SearchProjectsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchProjectsRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchProjectsRequest getDefaultInstance()
Returns
Type Description
SearchProjectsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchProjectsRequest.Builder newBuilder()
Returns
Type Description
SearchProjectsRequest.Builder

newBuilder(SearchProjectsRequest prototype)

public static SearchProjectsRequest.Builder newBuilder(SearchProjectsRequest prototype)
Parameter
Name Description
prototype SearchProjectsRequest
Returns
Type Description
SearchProjectsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchProjectsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchProjectsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchProjectsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchProjectsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchProjectsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchProjectsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchProjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchProjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchProjectsRequest> parser()
Returns
Type Description
Parser<SearchProjectsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchProjectsRequest getDefaultInstanceForType()
Returns
Type Description
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
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.

getParserForType()

public Parser<SearchProjectsRequest> getParserForType()
Returns
Type Description
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, 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchProjectsRequest.Builder newBuilderForType()
Returns
Type Description
SearchProjectsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchProjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchProjectsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchProjectsRequest.Builder toBuilder()
Returns
Type Description
SearchProjectsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException