- 1.55.0 (latest)
- 1.54.0
- 1.53.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.6
- 1.4.0
- 1.3.2
- 1.2.12
public static final class SearchFoldersRequest.Builder extends GeneratedMessageV3.Builder<SearchFoldersRequest.Builder> implements SearchFoldersRequestOrBuilderThe request message for searching folders.
Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchFoldersRequest.BuilderImplements
SearchFoldersRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchFoldersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
build()
public SearchFoldersRequest build()| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest | |
buildPartial()
public SearchFoldersRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest | |
clear()
public SearchFoldersRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public SearchFoldersRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchFoldersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
clearPageSize()
public SearchFoldersRequest.Builder clearPageSize()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 |
SearchFoldersRequest.Builder | This builder for chaining. |
clearPageToken()
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];
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | This builder for chaining. |
clearQuery()
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];
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | This builder for chaining. |
clone()
public SearchFoldersRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
getDefaultInstanceForType()
public SearchFoldersRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getPageSize()
public int 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. |
getQuery()
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];
| 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:
- 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];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for query. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(SearchFoldersRequest other)
public SearchFoldersRequest.Builder mergeFrom(SearchFoldersRequest other)| Parameter | |
|---|---|
| Name | Description |
other | SearchFoldersRequest |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchFoldersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public SearchFoldersRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchFoldersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchFoldersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
setPageSize(int value)
public SearchFoldersRequest.Builder setPageSize(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | This builder for chaining. |
setPageToken(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | This builder for chaining. |
setQuery(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | This builder for chaining. |
setQueryBytes(ByteString value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchFoldersRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchFoldersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchFoldersRequest.Builder | |