Class SearchFoldersRequest (1.45.0)

public final class SearchFoldersRequest extends GeneratedMessageV3 implements SearchFoldersRequestOrBuilder

The request message for searching folders.

Protobuf type google.cloud.resourcemanager.v3.SearchFoldersRequest

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchFoldersRequest getDefaultInstance()
Returns
Type Description
SearchFoldersRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchFoldersRequest.Builder newBuilder()
Returns
Type Description
SearchFoldersRequest.Builder

newBuilder(SearchFoldersRequest prototype)

public static SearchFoldersRequest.Builder newBuilder(SearchFoldersRequest prototype)
Parameter
Name Description
prototype SearchFoldersRequest
Returns
Type Description
SearchFoldersRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchFoldersRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchFoldersRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchFoldersRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchFoldersRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchFoldersRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchFoldersRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchFoldersRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchFoldersRequest> parser()
Returns
Type Description
Parser<SearchFoldersRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchFoldersRequest getDefaultInstanceForType()
Returns
Type Description
SearchFoldersRequest

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.

getParserForType()

public Parser<SearchFoldersRequest> getParserForType()
Returns
Type Description
Parser<SearchFoldersRequest>
Overrides

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.

    getSerializedSize()

    public int getSerializedSize()
    Returns
    Type Description
    int
    Overrides

    hashCode()

    public int hashCode()
    Returns
    Type Description
    int
    Overrides

    internalGetFieldAccessorTable()

    protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
    Returns
    Type Description
    FieldAccessorTable
    Overrides

    isInitialized()

    public final boolean isInitialized()
    Returns
    Type Description
    boolean
    Overrides

    newBuilderForType()

    public SearchFoldersRequest.Builder newBuilderForType()
    Returns
    Type Description
    SearchFoldersRequest.Builder

    newBuilderForType(GeneratedMessageV3.BuilderParent parent)

    protected SearchFoldersRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
    Parameter
    Name Description
    parent BuilderParent
    Returns
    Type Description
    SearchFoldersRequest.Builder
    Overrides

    newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

    protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
    Parameter
    Name Description
    unused UnusedPrivateParameter
    Returns
    Type Description
    Object
    Overrides

    toBuilder()

    public SearchFoldersRequest.Builder toBuilder()
    Returns
    Type Description
    SearchFoldersRequest.Builder

    writeTo(CodedOutputStream output)

    public void writeTo(CodedOutputStream output)
    Parameter
    Name Description
    output CodedOutputStream
    Overrides
    Exceptions
    Type Description
    IOException