Class ListTransferRunsRequest.Builder (2.45.0)

public static final class ListTransferRunsRequest.Builder extends GeneratedMessageV3.Builder<ListTransferRunsRequest.Builder> implements ListTransferRunsRequestOrBuilder

A request to list data transfer runs.

Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest

Static Methods

getDescriptor()

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

Methods

addAllStates(Iterable<? extends TransferState> values)

public ListTransferRunsRequest.Builder addAllStates(Iterable<? extends TransferState> values)

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Parameter
Name Description
values Iterable<? extends com.google.cloud.bigquery.datatransfer.v1.TransferState>

The states to add.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

addAllStatesValue(Iterable<Integer> values)

public ListTransferRunsRequest.Builder addAllStatesValue(Iterable<Integer> values)

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for states to add.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addStates(TransferState value)

public ListTransferRunsRequest.Builder addStates(TransferState value)

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Parameter
Name Description
value TransferState

The states to add.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

addStatesValue(int value)

public ListTransferRunsRequest.Builder addStatesValue(int value)

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for states to add.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

build()

public ListTransferRunsRequest build()
Returns
Type Description
ListTransferRunsRequest

buildPartial()

public ListTransferRunsRequest buildPartial()
Returns
Type Description
ListTransferRunsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListTransferRunsRequest.Builder clearPageSize()

Page size. The default page size is the maximum value of 1000 results.

int32 page_size = 4;

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

clearPageToken()

public ListTransferRunsRequest.Builder clearPageToken()

Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

string page_token = 3;

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

clearParent()

public ListTransferRunsRequest.Builder clearParent()

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

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

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

clearRunAttempt()

public ListTransferRunsRequest.Builder clearRunAttempt()

Indicates how run attempts are to be pulled.

.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

clearStates()

public ListTransferRunsRequest.Builder clearStates()

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListTransferRunsRequest getDefaultInstanceForType()
Returns
Type Description
ListTransferRunsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Page size. The default page size is the maximum value of 1000 results.

int32 page_size = 4;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

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

Returns
Type Description
ByteString

The bytes for parent.

getRunAttempt()

public ListTransferRunsRequest.RunAttempt getRunAttempt()

Indicates how run attempts are to be pulled.

.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;

Returns
Type Description
ListTransferRunsRequest.RunAttempt

The runAttempt.

getRunAttemptValue()

public int getRunAttemptValue()

Indicates how run attempts are to be pulled.

.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;

Returns
Type Description
int

The enum numeric value on the wire for runAttempt.

getStates(int index)

public TransferState getStates(int index)

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
TransferState

The states at the given index.

getStatesCount()

public int getStatesCount()

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Returns
Type Description
int

The count of states.

getStatesList()

public List<TransferState> getStatesList()

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Returns
Type Description
List<TransferState>

A list containing the states.

getStatesValue(int index)

public int getStatesValue(int index)

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of states at the given index.

getStatesValueList()

public List<Integer> getStatesValueList()

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for states.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListTransferRunsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListTransferRunsRequest.Builder setPageSize(int value)

Page size. The default page size is the maximum value of 1000 results.

int32 page_size = 4;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListTransferRunsRequest.Builder setPageToken(String value)

Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListTransferRunsRequest.Builder setPageTokenBytes(ByteString value)

Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

setParent(String value)

public ListTransferRunsRequest.Builder setParent(String value)

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_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
ListTransferRunsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListTransferRunsRequest.Builder setParentBytes(ByteString value)

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_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
ListTransferRunsRequest.Builder

This builder for chaining.

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

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

setRunAttempt(ListTransferRunsRequest.RunAttempt value)

public ListTransferRunsRequest.Builder setRunAttempt(ListTransferRunsRequest.RunAttempt value)

Indicates how run attempts are to be pulled.

.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;

Parameter
Name Description
value ListTransferRunsRequest.RunAttempt

The runAttempt to set.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

setRunAttemptValue(int value)

public ListTransferRunsRequest.Builder setRunAttemptValue(int value)

Indicates how run attempts are to be pulled.

.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for runAttempt to set.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

setStates(int index, TransferState value)

public ListTransferRunsRequest.Builder setStates(int index, TransferState value)

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Parameters
Name Description
index int

The index to set the value at.

value TransferState

The states to set.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

setStatesValue(int index, int value)

public ListTransferRunsRequest.Builder setStatesValue(int index, int value)

When specified, only transfer runs with requested states are returned.

repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for states to set.

Returns
Type Description
ListTransferRunsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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