Class ListDataScansRequest.Builder (1.41.0)

public static final class ListDataScansRequest.Builder extends GeneratedMessageV3.Builder<ListDataScansRequest.Builder> implements ListDataScansRequestOrBuilder

List dataScans request.

Protobuf type google.cloud.dataplex.v1.ListDataScansRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListDataScansRequest build()
Returns
Type Description
ListDataScansRequest

buildPartial()

public ListDataScansRequest buildPartial()
Returns
Type Description
ListDataScansRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListDataScansRequest.Builder clearFilter()

Optional. Filter request.

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

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOrderBy()

public ListDataScansRequest.Builder clearOrderBy()

Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.

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

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

clearPageSize()

public ListDataScansRequest.Builder clearPageSize()

Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans 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
Type Description
ListDataScansRequest.Builder

This builder for chaining.

clearPageToken()

public ListDataScansRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

clearParent()

public ListDataScansRequest.Builder clearParent()

Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

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

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListDataScansRequest getDefaultInstanceForType()
Returns
Type Description
ListDataScansRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Filter request.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter request.

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.

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

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans 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
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans 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 ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans 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 resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListDataScansRequest.Builder setFilter(String value)

Optional. Filter request.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListDataScansRequest.Builder setFilterBytes(ByteString value)

Optional. Filter request.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListDataScansRequest.Builder setOrderBy(String value)

Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.

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

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListDataScansRequest.Builder setOrderByBytes(ByteString value)

Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListDataScansRequest.Builder setPageSize(int value)

Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans 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
Name Description
value int

The pageSize to set.

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListDataScansRequest.Builder setPageToken(String value)

Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans 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
ListDataScansRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDataScansRequest.Builder setPageTokenBytes(ByteString value)

Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans 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
ListDataScansRequest.Builder

This builder for chaining.

setParent(String value)

public ListDataScansRequest.Builder setParent(String value)

Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListDataScansRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListDataScansRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the parent location: projects/{project}/locations/{location_id} where project refers to a project_id or project_number and location_id refers to a GCP region.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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