public static final class SearchFoldersRequest.Builder extends GeneratedMessageV3.Builder<SearchFoldersRequest.Builder> implements SearchFoldersRequestOrBuilder
The request message for searching folders.Protobuf type
google.cloud.resourcemanager.v3.SearchFoldersRequest
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
mergeDelimitedFrom, mergeDelimitedFrom
mergeFrom
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder clear()
clear
in interface Message.Builder
clear
in interface MessageLite.Builder
clear
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface Message.Builder
getDescriptorForType
in interface MessageOrBuilder
getDescriptorForType
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder
public SearchFoldersRequest build()
build
in interface Message.Builder
build
in interface MessageLite.Builder
public SearchFoldersRequest buildPartial()
buildPartial
in interface Message.Builder
buildPartial
in interface MessageLite.Builder
public SearchFoldersRequest.Builder clone()
clone
in interface Message.Builder
clone
in interface MessageLite.Builder
clone
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
setField
in interface Message.Builder
setField
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder clearField(Descriptors.FieldDescriptor field)
clearField
in interface Message.Builder
clearField
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof
in interface Message.Builder
clearOneof
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField
in interface Message.Builder
setRepeatedField
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
addRepeatedField
in interface Message.Builder
addRepeatedField
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder mergeFrom(Message other)
mergeFrom
in interface Message.Builder
mergeFrom
in class AbstractMessage.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder mergeFrom(SearchFoldersRequest other)
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public SearchFoldersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom
in interface Message.Builder
mergeFrom
in interface MessageLite.Builder
mergeFrom
in class AbstractMessage.Builder<SearchFoldersRequest.Builder>
IOException
public 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 SearchFoldersRequestOrBuilder
public SearchFoldersRequest.Builder setPageSize(int value)
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];
value
- The pageSize to set.public SearchFoldersRequest.Builder clearPageSize()
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];
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];
getPageToken
in interface SearchFoldersRequestOrBuilder
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];
getPageTokenBytes
in interface SearchFoldersRequestOrBuilder
public SearchFoldersRequest.Builder setPageToken(String value)
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];
value
- The pageToken to set.public SearchFoldersRequest.Builder clearPageToken()
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];
public SearchFoldersRequest.Builder setPageTokenBytes(ByteString value)
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];
value
- The bytes for pageToken to set.public 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 SearchFoldersRequestOrBuilder
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: * 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 SearchFoldersRequestOrBuilder
public SearchFoldersRequest.Builder setQuery(String value)
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];
value
- The query to set.public SearchFoldersRequest.Builder clearQuery()
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];
public SearchFoldersRequest.Builder setQueryBytes(ByteString value)
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];
value
- The bytes for query to set.public final SearchFoldersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields
in interface Message.Builder
setUnknownFields
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
public final SearchFoldersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields
in interface Message.Builder
mergeUnknownFields
in class GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
Copyright © 2022 Google LLC. All rights reserved.