Interface ListTransferRunsRequestOrBuilder (2.30.0)

public interface ListTransferRunsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.