public final class SearchFoldersRequest extends GeneratedMessageV3 implements SearchFoldersRequestOrBuilder
The request message for searching folders.
Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest
Static Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchFoldersRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchFoldersRequest.Builder newBuilder()
Returns
newBuilder(SearchFoldersRequest prototype)
public static SearchFoldersRequest.Builder newBuilder(SearchFoldersRequest prototype)
Parameter
Returns
public static SearchFoldersRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchFoldersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchFoldersRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchFoldersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchFoldersRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchFoldersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchFoldersRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchFoldersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchFoldersRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchFoldersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchFoldersRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchFoldersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchFoldersRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SearchFoldersRequest getDefaultInstanceForType()
Returns
getPageSize()
Optional. The maximum number of folders to return in the response.
If unspecified, server picks an appropriate default.
int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| int | The pageSize.
|
getPageToken()
public String getPageToken()
Optional. A pagination token returned from a previous call to SearchFolders
that indicates from where search should continue.
string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional. A pagination token returned from a previous call to SearchFolders
that indicates from where search should continue.
string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<SearchFoldersRequest> getParserForType()
Returns
Overrides
getQuery()
Optional. Search criteria used to select the folders to return.
If no search criteria is specified then all accessible folders will be
returned.
Query expressions can be used to restrict results based upon displayName,
state and parent, where the operators = (:) NOT, AND and OR
can be used along with the suffix wildcard symbol *.
The displayName field in a query expression should use escaped quotes
for values that include whitespace to prevent unexpected behavior.
`
| Field | Description |
|---|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
displayName=Test*
returns Folder resources whose display name
starts with "Test".
Query state=ACTIVE
returns Folder resources with
state
set to ACTIVE
.
Query parent=folders/123
returns Folder resources that have
folders/123
as a parent resource.
Query parent=folders/123 AND state=ACTIVE
returns active
Folder resources that have folders/123
as a parent resource.
Query displayName=\\"Test String\\"` returns Folder resources with
display names that include both "Test" and "String".
string query = 3 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The query.
|
getQueryBytes()
public ByteString getQueryBytes()
Optional. Search criteria used to select the folders to return.
If no search criteria is specified then all accessible folders will be
returned.
Query expressions can be used to restrict results based upon displayName,
state and parent, where the operators = (:) NOT, AND and OR
can be used along with the suffix wildcard symbol *.
The displayName field in a query expression should use escaped quotes
for values that include whitespace to prevent unexpected behavior.
`
| Field | Description |
|---|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
displayName=Test*
returns Folder resources whose display name
starts with "Test".
Query state=ACTIVE
returns Folder resources with
state
set to ACTIVE
.
Query parent=folders/123
returns Folder resources that have
folders/123
as a parent resource.
Query parent=folders/123 AND state=ACTIVE
returns active
Folder resources that have folders/123
as a parent resource.
Query displayName=\\"Test String\\"` returns Folder resources with
display names that include both "Test" and "String".
string query = 3 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchFoldersRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchFoldersRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchFoldersRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
