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
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
RUN_ATTEMPT_FIELD_NUMBER
public static final int RUN_ATTEMPT_FIELD_NUMBER
Field Value
STATES_FIELD_NUMBER
public static final int STATES_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static ListTransferRunsRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public ListTransferRunsRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getPageSize()
Page size. The default page size is the maximum value of 1000 results.
int32 page_size = 4;
| 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;
| 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;
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<ListTransferRunsRequest> getParserForType()
Returns
Overrides
getRunAttempt()
public ListTransferRunsRequest.RunAttempt getRunAttempt()
Indicates how run attempts are to be pulled.
.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;
getRunAttemptValue()
public int getRunAttemptValue()
Indicates how run attempts are to be pulled.
.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;
| Type | Description |
| int | The enum numeric value on the wire for runAttempt.
|
getSerializedSize()
public int getSerializedSize()
Returns
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;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
getStatesCount()
public int getStatesCount()
When specified, only transfer runs with requested states are returned.
repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
| 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;
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;
| 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;
| Type | Description |
| List<Integer> | A list containing the enum numeric values on the wire for states.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static ListTransferRunsRequest.Builder newBuilder()
Returns
newBuilder(ListTransferRunsRequest prototype)
public static ListTransferRunsRequest.Builder newBuilder(ListTransferRunsRequest prototype)
Parameter
Returns
newBuilderForType()
public ListTransferRunsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListTransferRunsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ListTransferRunsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTransferRunsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListTransferRunsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListTransferRunsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListTransferRunsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListTransferRunsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTransferRunsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListTransferRunsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListTransferRunsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListTransferRunsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListTransferRunsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListTransferRunsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListTransferRunsRequest> parser()
Returns
toBuilder()
public ListTransferRunsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
