Class ListEnvironmentsRequest.Builder (1.20.0)

public static final class ListEnvironmentsRequest.Builder extends GeneratedMessageV3.Builder<ListEnvironmentsRequest.Builder> implements ListEnvironmentsRequestOrBuilder

List environments request.

Protobuf type google.cloud.dataplex.v1.ListEnvironmentsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListEnvironmentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

build()

public ListEnvironmentsRequest build()
Returns
TypeDescription
ListEnvironmentsRequest

buildPartial()

public ListEnvironmentsRequest buildPartial()
Returns
TypeDescription
ListEnvironmentsRequest

clear()

public ListEnvironmentsRequest.Builder clear()
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListEnvironmentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

clearFilter()

public ListEnvironmentsRequest.Builder clearFilter()

Optional. Filter request.

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

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListEnvironmentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

clearOrderBy()

public ListEnvironmentsRequest.Builder clearOrderBy()

Optional. Order by fields for the result.

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

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

clearPageSize()

public ListEnvironmentsRequest.Builder clearPageSize()

Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

clearPageToken()

public ListEnvironmentsRequest.Builder clearPageToken()

Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.

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

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

clearParent()

public ListEnvironmentsRequest.Builder clearParent()

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

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

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

clone()

public ListEnvironmentsRequest.Builder clone()
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListEnvironmentsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListEnvironmentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Optional. Filter request.

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

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter request.

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

Returns
TypeDescription
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Order by fields for the result.

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

Returns
TypeDescription
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Order by fields for the result.

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

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.

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

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListEnvironmentsRequest other)

public ListEnvironmentsRequest.Builder mergeFrom(ListEnvironmentsRequest other)
Parameter
NameDescription
otherListEnvironmentsRequest
Returns
TypeDescription
ListEnvironmentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListEnvironmentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListEnvironmentsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListEnvironmentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListEnvironmentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

setFilter(String value)

public ListEnvironmentsRequest.Builder setFilter(String value)

Optional. Filter request.

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

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListEnvironmentsRequest.Builder setFilterBytes(ByteString value)

Optional. Filter request.

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

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListEnvironmentsRequest.Builder setOrderBy(String value)

Optional. Order by fields for the result.

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

Parameter
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListEnvironmentsRequest.Builder setOrderByBytes(ByteString value)

Optional. Order by fields for the result.

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

Parameter
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListEnvironmentsRequest.Builder setPageSize(int value)

Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

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

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEnvironmentsRequest.Builder setPageToken(String value)

Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.

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

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEnvironmentsRequest.Builder setPageTokenBytes(ByteString value)

Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token.

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

setParent(String value)

public ListEnvironmentsRequest.Builder setParent(String value)

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEnvironmentsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the parent lake: projects/{project_id}/locations/{location_id}/lakes/{lake_id}.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListEnvironmentsRequest.Builder

This builder for chaining.

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

public ListEnvironmentsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListEnvironmentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListEnvironmentsRequest.Builder
Overrides