Class SearchFoldersRequest (1.42.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
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchFoldersRequest getDefaultInstance()
Returns
TypeDescription
SearchFoldersRequest

getDescriptor()

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

newBuilder()

public static SearchFoldersRequest.Builder newBuilder()
Returns
TypeDescription
SearchFoldersRequest.Builder

newBuilder(SearchFoldersRequest prototype)

public static SearchFoldersRequest.Builder newBuilder(SearchFoldersRequest prototype)
Parameter
NameDescription
prototypeSearchFoldersRequest
Returns
TypeDescription
SearchFoldersRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchFoldersRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchFoldersRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchFoldersRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchFoldersRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchFoldersRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchFoldersRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchFoldersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchFoldersRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchFoldersRequest> parser()
Returns
TypeDescription
Parser<SearchFoldersRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchFoldersRequest getDefaultInstanceForType()
Returns
TypeDescription
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
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.

getParserForType()

public Parser<SearchFoldersRequest> getParserForType()
Returns
TypeDescription
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.

`

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.

    getSerializedSize()

    public int getSerializedSize()
    Returns
    TypeDescription
    int
    Overrides

    hashCode()

    public int hashCode()
    Returns
    TypeDescription
    int
    Overrides

    internalGetFieldAccessorTable()

    protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
    Returns
    TypeDescription
    FieldAccessorTable
    Overrides

    isInitialized()

    public final boolean isInitialized()
    Returns
    TypeDescription
    boolean
    Overrides

    newBuilderForType()

    public SearchFoldersRequest.Builder newBuilderForType()
    Returns
    TypeDescription
    SearchFoldersRequest.Builder

    newBuilderForType(GeneratedMessageV3.BuilderParent parent)

    protected SearchFoldersRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
    Parameter
    NameDescription
    parentBuilderParent
    Returns
    TypeDescription
    SearchFoldersRequest.Builder
    Overrides

    newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

    protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
    Parameter
    NameDescription
    unusedUnusedPrivateParameter
    Returns
    TypeDescription
    Object
    Overrides

    toBuilder()

    public SearchFoldersRequest.Builder toBuilder()
    Returns
    TypeDescription
    SearchFoldersRequest.Builder

    writeTo(CodedOutputStream output)

    public void writeTo(CodedOutputStream output)
    Parameter
    NameDescription
    outputCodedOutputStream
    Overrides
    Exceptions
    TypeDescription
    IOException