Class QueryUserRootContentsRequest.Builder (0.84.0)

public static final class QueryUserRootContentsRequest.Builder extends GeneratedMessage.Builder<QueryUserRootContentsRequest.Builder> implements QueryUserRootContentsRequestOrBuilder

QueryUserRootContents request message.

Protobuf type google.cloud.dataform.v1beta1.QueryUserRootContentsRequest

Static Methods

getDescriptor()

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

Methods

build()

public QueryUserRootContentsRequest build()
Returns
Type Description
QueryUserRootContentsRequest

buildPartial()

public QueryUserRootContentsRequest buildPartial()
Returns
Type Description
QueryUserRootContentsRequest

clear()

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

clearFilter()

public QueryUserRootContentsRequest.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
QueryUserRootContentsRequest.Builder

This builder for chaining.

clearLocation()

public QueryUserRootContentsRequest.Builder clearLocation()

Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

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

Returns
Type Description
QueryUserRootContentsRequest.Builder

This builder for chaining.

clearOrderBy()

public QueryUserRootContentsRequest.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), created_at, last_modified_at. Examples:

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

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

Returns
Type Description
QueryUserRootContentsRequest.Builder

This builder for chaining.

clearPageSize()

public QueryUserRootContentsRequest.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
QueryUserRootContentsRequest.Builder

This builder for chaining.

clearPageToken()

public QueryUserRootContentsRequest.Builder clearPageToken()

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

When paginating, all other parameters provided to QueryUserRootFolderContents, 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
QueryUserRootContentsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public QueryUserRootContentsRequest getDefaultInstanceForType()
Returns
Type Description
QueryUserRootContentsRequest

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.

getLocation()

public String getLocation()

Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

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

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

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

Returns
Type Description
ByteString

The bytes for location.

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), created_at, last_modified_at. 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), created_at, last_modified_at. 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 QueryUserRootContents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to QueryUserRootFolderContents, 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 QueryUserRootContents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to QueryUserRootFolderContents, 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(QueryUserRootContentsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public QueryUserRootContentsRequest.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
QueryUserRootContentsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public QueryUserRootContentsRequest.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
QueryUserRootContentsRequest.Builder

This builder for chaining.

setLocation(String value)

public QueryUserRootContentsRequest.Builder setLocation(String value)

Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

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

Parameter
Name Description
value String

The location to set.

Returns
Type Description
QueryUserRootContentsRequest.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public QueryUserRootContentsRequest.Builder setLocationBytes(ByteString value)

Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

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

Parameter
Name Description
value ByteString

The bytes for location to set.

Returns
Type Description
QueryUserRootContentsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public QueryUserRootContentsRequest.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), created_at, last_modified_at. 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
QueryUserRootContentsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public QueryUserRootContentsRequest.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), created_at, last_modified_at. 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
QueryUserRootContentsRequest.Builder

This builder for chaining.

setPageSize(int value)

public QueryUserRootContentsRequest.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
QueryUserRootContentsRequest.Builder

This builder for chaining.

setPageToken(String value)

public QueryUserRootContentsRequest.Builder setPageToken(String value)

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

When paginating, all other parameters provided to QueryUserRootFolderContents, 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
QueryUserRootContentsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public QueryUserRootContentsRequest.Builder setPageTokenBytes(ByteString value)

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

When paginating, all other parameters provided to QueryUserRootFolderContents, 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
QueryUserRootContentsRequest.Builder

This builder for chaining.