Class SearchFoldersRequest.Builder (1.33.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchFoldersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchFoldersRequest.Builder
Overrides

build()

public SearchFoldersRequest build()
Returns
TypeDescription
SearchFoldersRequest

buildPartial()

public SearchFoldersRequest buildPartial()
Returns
TypeDescription
SearchFoldersRequest

clear()

public SearchFoldersRequest.Builder clear()
Returns
TypeDescription
SearchFoldersRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchFoldersRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchFoldersRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchFoldersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchFoldersRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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.

`

FieldDescription
displayNameFilters by displayName.
parentFilters by parent (for example: folders/123).
state, lifecycleStateFilters 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
    TypeDescription
    SearchFoldersRequest.Builder

    This builder for chaining.

    clone()

    public SearchFoldersRequest.Builder clone()
    Returns
    TypeDescription
    SearchFoldersRequest.Builder
    Overrides

    getDefaultInstanceForType()

    public SearchFoldersRequest getDefaultInstanceForType()
    Returns
    TypeDescription
    SearchFoldersRequest

    getDescriptorForType()

    public Descriptors.Descriptor getDescriptorForType()
    Returns
    TypeDescription
    Descriptor
    Overrides

    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
    TypeDescription
    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
    TypeDescription
    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
    TypeDescription
    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.

    `

    FieldDescription
    displayNameFilters by displayName.
    parentFilters by parent (for example: folders/123).
    state, lifecycleStateFilters 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
    TypeDescription
    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.

    `

    FieldDescription
    displayNameFilters by displayName.
    parentFilters by parent (for example: folders/123).
    state, lifecycleStateFilters 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
    TypeDescription
    ByteString

    The bytes for query.

    internalGetFieldAccessorTable()

    protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
    Returns
    TypeDescription
    FieldAccessorTable
    Overrides

    isInitialized()

    public final boolean isInitialized()
    Returns
    TypeDescription
    boolean
    Overrides

    mergeFrom(SearchFoldersRequest other)

    public SearchFoldersRequest.Builder mergeFrom(SearchFoldersRequest other)
    Parameter
    NameDescription
    otherSearchFoldersRequest
    Returns
    TypeDescription
    SearchFoldersRequest.Builder

    mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

    public SearchFoldersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
    Parameters
    NameDescription
    inputCodedInputStream
    extensionRegistryExtensionRegistryLite
    Returns
    TypeDescription
    SearchFoldersRequest.Builder
    Overrides
    Exceptions
    TypeDescription
    IOException

    mergeFrom(Message other)

    public SearchFoldersRequest.Builder mergeFrom(Message other)
    Parameter
    NameDescription
    otherMessage
    Returns
    TypeDescription
    SearchFoldersRequest.Builder
    Overrides

    mergeUnknownFields(UnknownFieldSet unknownFields)

    public final SearchFoldersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
    Parameter
    NameDescription
    unknownFieldsUnknownFieldSet
    Returns
    TypeDescription
    SearchFoldersRequest.Builder
    Overrides

    setField(Descriptors.FieldDescriptor field, Object value)

    public SearchFoldersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
    Parameters
    NameDescription
    fieldFieldDescriptor
    valueObject
    Returns
    TypeDescription
    SearchFoldersRequest.Builder
    Overrides

    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
    NameDescription
    valueint

    The pageSize to set.

    Returns
    TypeDescription
    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
    NameDescription
    valueString

    The pageToken to set.

    Returns
    TypeDescription
    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
    NameDescription
    valueByteString

    The bytes for pageToken to set.

    Returns
    TypeDescription
    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.

    `

    FieldDescription
    displayNameFilters by displayName.
    parentFilters by parent (for example: folders/123).
    state, lifecycleStateFilters 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
    NameDescription
    valueString

    The query to set.

    Returns
    TypeDescription
    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.

    `

    FieldDescription
    displayNameFilters by displayName.
    parentFilters by parent (for example: folders/123).
    state, lifecycleStateFilters 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
    NameDescription
    valueByteString

    The bytes for query to set.

    Returns
    TypeDescription
    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
    NameDescription
    fieldFieldDescriptor
    indexint
    valueObject
    Returns
    TypeDescription
    SearchFoldersRequest.Builder
    Overrides

    setUnknownFields(UnknownFieldSet unknownFields)

    public final SearchFoldersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
    Parameter
    NameDescription
    unknownFieldsUnknownFieldSet
    Returns
    TypeDescription
    SearchFoldersRequest.Builder
    Overrides