Class QueryFolderContentsRequest.Builder (0.84.0)

public static final class QueryFolderContentsRequest.Builder extends GeneratedMessage.Builder<QueryFolderContentsRequest.Builder> implements QueryFolderContentsRequestOrBuilder

QueryFolderContents request message.

Protobuf type google.cloud.dataform.v1beta1.QueryFolderContentsRequest

Static Methods

getDescriptor()

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

Methods

build()

public QueryFolderContentsRequest build()
Returns
Type Description
QueryFolderContentsRequest

buildPartial()

public QueryFolderContentsRequest buildPartial()
Returns
Type Description
QueryFolderContentsRequest

clear()

public QueryFolderContentsRequest.Builder clear()
Returns
Type Description
QueryFolderContentsRequest.Builder
Overrides

clearFilter()

public QueryFolderContentsRequest.Builder clearFilter()

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
QueryFolderContentsRequest.Builder

This builder for chaining.

clearFolder()

public QueryFolderContentsRequest.Builder clearFolder()

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
QueryFolderContentsRequest.Builder

This builder for chaining.

clearOrderBy()

public QueryFolderContentsRequest.Builder clearOrderBy()

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
QueryFolderContentsRequest.Builder

This builder for chaining.

clearPageSize()

public QueryFolderContentsRequest.Builder clearPageSize()

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
QueryFolderContentsRequest.Builder

This builder for chaining.

clearPageToken()

public QueryFolderContentsRequest.Builder clearPageToken()

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
QueryFolderContentsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public QueryFolderContentsRequest getDefaultInstanceForType()
Returns
Type Description
QueryFolderContentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(QueryFolderContentsRequest other)

public QueryFolderContentsRequest.Builder mergeFrom(QueryFolderContentsRequest other)
Parameter
Name Description
other QueryFolderContentsRequest
Returns
Type Description
QueryFolderContentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryFolderContentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryFolderContentsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public QueryFolderContentsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
QueryFolderContentsRequest.Builder
Overrides

setFilter(String value)

public QueryFolderContentsRequest.Builder setFilter(String value)

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public QueryFolderContentsRequest.Builder setFilterBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.

setFolder(String value)

public QueryFolderContentsRequest.Builder setFolder(String value)

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) = { ... }

Parameter
Name Description
value String

The folder to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.

setFolderBytes(ByteString value)

public QueryFolderContentsRequest.Builder setFolderBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for folder to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public QueryFolderContentsRequest.Builder setOrderBy(String value)

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

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public QueryFolderContentsRequest.Builder setOrderByBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.

setPageSize(int value)

public QueryFolderContentsRequest.Builder setPageSize(int value)

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.

setPageToken(String value)

public QueryFolderContentsRequest.Builder setPageToken(String value)

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public QueryFolderContentsRequest.Builder setPageTokenBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
QueryFolderContentsRequest.Builder

This builder for chaining.