Class ListTransferRunsRequest.Builder (2.4.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
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.cloud.bigquery.datatransfer.v1.TransferState>

The states to add.

Returns
TypeDescription
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
NameDescription
valuesIterable<Integer>

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

Returns
TypeDescription
ListTransferRunsRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListTransferRunsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueTransferState

The states to add.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
ListTransferRunsRequest.Builder

This builder for chaining.

build()

public ListTransferRunsRequest build()
Returns
TypeDescription
ListTransferRunsRequest

buildPartial()

public ListTransferRunsRequest buildPartial()
Returns
TypeDescription
ListTransferRunsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

public ListTransferRunsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ListTransferRunsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListTransferRunsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListTransferRunsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

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

int32 page_size = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
List<Integer>

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListTransferRunsRequest other)

public ListTransferRunsRequest.Builder mergeFrom(ListTransferRunsRequest other)
Parameter
NameDescription
otherListTransferRunsRequest
Returns
TypeDescription
ListTransferRunsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public ListTransferRunsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueListTransferRunsRequest.RunAttempt

The runAttempt to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueTransferState

The states to set.

Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueint

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

Returns
TypeDescription
ListTransferRunsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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