Class ListTransferRunsRequest (2.0.27)

public final class ListTransferRunsRequest extends GeneratedMessageV3 implements ListTransferRunsRequestOrBuilder

A request to list data transfer runs. UI can use this method to show/filter specific data transfer runs. The data source can use this method to request all scheduled transfer runs.

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

Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

RUN_ATTEMPT_FIELD_NUMBER

public static final int RUN_ATTEMPT_FIELD_NUMBER
Field Value
TypeDescription
int

STATES_FIELD_NUMBER

public static final int STATES_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static ListTransferRunsRequest getDefaultInstance()
Returns
TypeDescription
ListTransferRunsRequest

getDefaultInstanceForType()

public ListTransferRunsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListTransferRunsRequest

getDescriptor()

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

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.

getParserForType()

public Parser<ListTransferRunsRequest> getParserForType()
Returns
TypeDescription
Parser<ListTransferRunsRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static ListTransferRunsRequest.Builder newBuilder()
Returns
TypeDescription
ListTransferRunsRequest.Builder

newBuilder(ListTransferRunsRequest prototype)

public static ListTransferRunsRequest.Builder newBuilder(ListTransferRunsRequest prototype)
Parameter
NameDescription
prototypeListTransferRunsRequest
Returns
TypeDescription
ListTransferRunsRequest.Builder

newBuilderForType()

public ListTransferRunsRequest.Builder newBuilderForType()
Returns
TypeDescription
ListTransferRunsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListTransferRunsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListTransferRunsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static ListTransferRunsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTransferRunsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListTransferRunsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListTransferRunsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListTransferRunsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListTransferRunsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListTransferRunsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTransferRunsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListTransferRunsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListTransferRunsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListTransferRunsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListTransferRunsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListTransferRunsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListTransferRunsRequest> parser()
Returns
TypeDescription
Parser<ListTransferRunsRequest>

toBuilder()

public ListTransferRunsRequest.Builder toBuilder()
Returns
TypeDescription
ListTransferRunsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException