com.google.cloud.resourcemanager.v3

Class SearchFoldersRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

com.google.cloud.resourcemanager.v3.SearchFoldersRequest.Builder

All Implemented Interfaces:

SearchFoldersRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SearchFoldersRequest

public static final class SearchFoldersRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>
implements SearchFoldersRequestOrBuilder

 The request message for searching folders.
 

Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest

Method Summary

Modifier and Type	Method and Description
SearchFoldersRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchFoldersRequest	build()
SearchFoldersRequest	buildPartial()
SearchFoldersRequest.Builder	clear()
SearchFoldersRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchFoldersRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchFoldersRequest.Builder	clearPageSize() Optional.
SearchFoldersRequest.Builder	clearPageToken() Optional.
SearchFoldersRequest.Builder	clearQuery() Optional.
SearchFoldersRequest.Builder	clone()
SearchFoldersRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getQuery() Optional.
com.google.protobuf.ByteString	getQueryBytes() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SearchFoldersRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchFoldersRequest.Builder	mergeFrom(com.google.protobuf.Message other)
SearchFoldersRequest.Builder	mergeFrom(SearchFoldersRequest other)
SearchFoldersRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchFoldersRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchFoldersRequest.Builder	setPageSize(int value) Optional.
SearchFoldersRequest.Builder	setPageToken(String value) Optional.
SearchFoldersRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) Optional.
SearchFoldersRequest.Builder	setQuery(String value) Optional.
SearchFoldersRequest.Builder	setQueryBytes(com.google.protobuf.ByteString value) Optional.
SearchFoldersRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchFoldersRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

clear

public SearchFoldersRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

getDefaultInstanceForType

public SearchFoldersRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchFoldersRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SearchFoldersRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SearchFoldersRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

setField

public SearchFoldersRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

clearField

public SearchFoldersRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

clearOneof

public SearchFoldersRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

setRepeatedField

public SearchFoldersRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

addRepeatedField

public SearchFoldersRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

mergeFrom

public SearchFoldersRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchFoldersRequest.Builder>

mergeFrom

public SearchFoldersRequest.Builder mergeFrom(SearchFoldersRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

mergeFrom

public SearchFoldersRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchFoldersRequest.Builder>

Throws:

IOException

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];

Specified by:

getPageSize in interface SearchFoldersRequestOrBuilder

Returns:

The pageSize.

setPageSize

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];

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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];

Specified by:

getPageToken in interface SearchFoldersRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.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];

Specified by:

getPageTokenBytes in interface SearchFoldersRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

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];

Parameters:

value - The pageToken to set.

Returns:

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:

This builder for chaining.

setPageTokenBytes

public SearchFoldersRequest.Builder setPageTokenBytes(com.google.protobuf.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];

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

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];

Specified by:

getQuery in interface SearchFoldersRequestOrBuilder

Returns:

The query.

getQueryBytes

public com.google.protobuf.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];

Specified by:

getQueryBytes in interface SearchFoldersRequestOrBuilder

Returns:

The bytes for query.

setQuery

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];

Parameters:

value - The query to set.

Returns:

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:

This builder for chaining.

setQueryBytes

public SearchFoldersRequest.Builder setQueryBytes(com.google.protobuf.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];

Parameters:

value - The bytes for query to set.

Returns:

This builder for chaining.

setUnknownFields

public final SearchFoldersRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>

mergeUnknownFields

public final SearchFoldersRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchFoldersRequest.Builder>