Class QueryFolderContentsRequest (0.84.0)

public final class QueryFolderContentsRequest extends GeneratedMessage implements QueryFolderContentsRequestOrBuilder

QueryFolderContents request message.

Protobuf type google.cloud.dataform.v1beta1.QueryFolderContentsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

FOLDER_FIELD_NUMBER

public static final int FOLDER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

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

Static Methods

getDefaultInstance()

public static QueryFolderContentsRequest getDefaultInstance()
Returns
Type Description
QueryFolderContentsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(QueryFolderContentsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public QueryFolderContentsRequest getDefaultInstanceForType()
Returns
Type Description
QueryFolderContentsRequest

getFilter()

public String getFilter()

Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

Example:

  • filter="display_name="MyFolder""

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

Example:

  • filter="display_name="MyFolder""

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getFolder()

public String getFolder()

Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/*

string folder = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The folder.

getFolderBytes()

public ByteString getFolderBytes()

Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/*

string folder = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for folder.

getOrderBy()

public String getOrderBy()

Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

  • orderBy="display_name"
  • orderBy="display_name desc"

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

  • orderBy="display_name"
  • orderBy="display_name desc"

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Page token received from a previous QueryFolderContents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size, must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. Page token received from a previous QueryFolderContents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size, must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected QueryFolderContentsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueryFolderContentsRequest.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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