public final class SearchFoldersRequest extends GeneratedMessageV3 implements SearchFoldersRequestOrBuilder
The request message for searching folders.Protobuf type
google.cloud.resourcemanager.v3.SearchFoldersRequest| Modifier and Type | Class and Description |
|---|---|
static class |
SearchFoldersRequest.Builder
The request message for searching folders.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterAbstractMessageLite.InternalOneOfEnum| Modifier and Type | Field and Description |
|---|---|
static int |
PAGE_SIZE_FIELD_NUMBER |
static int |
PAGE_TOKEN_FIELD_NUMBER |
static int |
QUERY_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCodecanUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class GeneratedMessageV3public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public int 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];getPageSize in interface SearchFoldersRequestOrBuilderpublic 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];getPageToken in interface SearchFoldersRequestOrBuilderpublic 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];getPageTokenBytes in interface SearchFoldersRequestOrBuilderpublic String 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: * Query `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];getQuery in interface SearchFoldersRequestOrBuilderpublic 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: * Query `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];getQueryBytes in interface SearchFoldersRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static SearchFoldersRequest parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static SearchFoldersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static SearchFoldersRequest parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static SearchFoldersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static SearchFoldersRequest parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static SearchFoldersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static SearchFoldersRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static SearchFoldersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchFoldersRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static SearchFoldersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchFoldersRequest parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static SearchFoldersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic SearchFoldersRequest.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static SearchFoldersRequest.Builder newBuilder()
public static SearchFoldersRequest.Builder newBuilder(SearchFoldersRequest prototype)
public SearchFoldersRequest.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected SearchFoldersRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static SearchFoldersRequest getDefaultInstance()
public static Parser<SearchFoldersRequest> parser()
public Parser<SearchFoldersRequest> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public SearchFoldersRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.