public final class SearchFoldersRequest extends GeneratedMessageV3 implements SearchFoldersRequestOrBuilder
The request message for searching folders.
Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 SearchFoldersRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchFoldersRequest.Builder newBuilder()
newBuilder(SearchFoldersRequest prototype)
public static SearchFoldersRequest.Builder newBuilder(SearchFoldersRequest prototype)
public static SearchFoldersRequest parseDelimitedFrom(InputStream input)
public static SearchFoldersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchFoldersRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchFoldersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchFoldersRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchFoldersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchFoldersRequest parseFrom(CodedInputStream input)
public static SearchFoldersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchFoldersRequest parseFrom(InputStream input)
public static SearchFoldersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchFoldersRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchFoldersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchFoldersRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public SearchFoldersRequest getDefaultInstanceForType()
getPageSize()
Optional. The maximum number of folders to return in the response. The
server can return fewer folders than requested. If unspecified, server
picks an appropriate default.
int32 page_size = 1 [(.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
SearchFolders that indicates from where search 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
SearchFolders that indicates from where search should continue.
string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for pageToken.
|
getParserForType()
public Parser<SearchFoldersRequest> getParserForType()
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for query.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchFoldersRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchFoldersRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public SearchFoldersRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
