Class ListFederationsRequest.Builder (2.43.0) 

public static final class ListFederationsRequest.Builder extends GeneratedMessageV3.Builder<ListFederationsRequest.Builder> implements ListFederationsRequestOrBuilder

Request message for ListFederations.

Protobuf type google.cloud.metastore.v1alpha.ListFederationsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListFederationsRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListFederationsRequest build()
Returns
Type Description
ListFederationsRequest

buildPartial()

public ListFederationsRequest buildPartial()
Returns
Type Description
ListFederationsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListFederationsRequest.Builder clearFilter()

Optional. The filter to apply to list results.

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

Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListFederationsRequest.Builder clearOrderBy()

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

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

Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

clearPageSize()

public ListFederationsRequest.Builder clearPageSize()

Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.

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

Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListFederationsRequest.Builder clearPageToken()

Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token.

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

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

Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

clearParent()

public ListFederationsRequest.Builder clearParent()

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

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

Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListFederationsRequest getDefaultInstanceForType()
Returns
Type Description
ListFederationsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. The filter to apply to list results.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. The filter to apply to list results.

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

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

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token.

When paginating, other parameters provided to ListFederationServices 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. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token.

When paginating, other parameters provided to ListFederationServices 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 relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

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(ListFederationsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListFederationsRequest.Builder setFilter(String value)

Optional. The filter to apply to list results.

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

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListFederationsRequest.Builder setFilterBytes(ByteString value)

Optional. The filter to apply to list results.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListFederationsRequest.Builder setOrderBy(String value)

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

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

Parameter
Name Description
value String

The orderBy to set.
Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListFederationsRequest.Builder setOrderByBytes(ByteString value)

Optional. Specify the ordering of results as described in Sorting Order. If not specified, the results will be sorted in the default order.

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.
Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListFederationsRequest.Builder setPageSize(int value)

Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000.

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

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFederationsRequest.Builder setPageToken(String value)

Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token.

When paginating, other parameters provided to ListFederationServices 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
ListFederationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFederationsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page.

To retrieve the first page, supply an empty page token.

When paginating, other parameters provided to ListFederationServices 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
ListFederationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListFederationsRequest.Builder setParent(String value)

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListFederationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFederationsRequest.Builder setParentBytes(ByteString value)

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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