Class ListWorkspacesRequest.Builder (0.30.0)

public static final class ListWorkspacesRequest.Builder extends GeneratedMessageV3.Builder<ListWorkspacesRequest.Builder> implements ListWorkspacesRequestOrBuilder

ListWorkspaces request message.

Protobuf type google.cloud.dataform.v1beta1.ListWorkspacesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListWorkspacesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListWorkspacesRequest.Builder
Overrides

build()

public ListWorkspacesRequest build()
Returns
Type Description
ListWorkspacesRequest

buildPartial()

public ListWorkspacesRequest buildPartial()
Returns
Type Description
ListWorkspacesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public ListWorkspacesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListWorkspacesRequest.Builder
Overrides

clearFilter()

public ListWorkspacesRequest.Builder clearFilter()

Optional. Filter for the returned list.

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

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListWorkspacesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListWorkspacesRequest.Builder
Overrides

clearOrderBy()

public ListWorkspacesRequest.Builder clearOrderBy()

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

clearPageSize()

public ListWorkspacesRequest.Builder clearPageSize()

Optional. Maximum number of workspaces 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
ListWorkspacesRequest.Builder

This builder for chaining.

clearPageToken()

public ListWorkspacesRequest.Builder clearPageToken()

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

When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

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

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

clearParent()

public ListWorkspacesRequest.Builder clearParent()

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.

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

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

clone()

public ListWorkspacesRequest.Builder clone()
Returns
Type Description
ListWorkspacesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListWorkspacesRequest getDefaultInstanceForType()
Returns
Type Description
ListWorkspacesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter for the returned list.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter for the returned list.

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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 workspaces 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 ListWorkspaces call. Provide this to retrieve the subsequent page.

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

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

getParent()

public String getParent()

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListWorkspacesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListWorkspacesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListWorkspacesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListWorkspacesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListWorkspacesRequest.Builder
Overrides

setFilter(String value)

public ListWorkspacesRequest.Builder setFilter(String value)

Optional. Filter for the returned list.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListWorkspacesRequest.Builder setFilterBytes(ByteString value)

Optional. Filter for the returned list.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListWorkspacesRequest.Builder setOrderBy(String value)

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListWorkspacesRequest.Builder setOrderByBytes(ByteString value)

Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListWorkspacesRequest.Builder setPageSize(int value)

Optional. Maximum number of workspaces 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
ListWorkspacesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListWorkspacesRequest.Builder setPageToken(String value)

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

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

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListWorkspacesRequest.Builder setPageTokenBytes(ByteString value)

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

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

This builder for chaining.

setParent(String value)

public ListWorkspacesRequest.Builder setParent(String value)

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListWorkspacesRequest.Builder setParentBytes(ByteString value)

Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListWorkspacesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListWorkspacesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListWorkspacesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListWorkspacesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListWorkspacesRequest.Builder
Overrides