Package com.google.cloud.bigquery.datatransfer.v1

Interface ListTransferRunsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListTransferRunsRequest, ListTransferRunsRequest.Builder
    public interface ListTransferRunsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getPageSize()
      Page size.
      String getPageToken()
      Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results.
      com.google.protobuf.ByteString getPageTokenBytes()
      Pagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      ListTransferRunsRequest.RunAttempt getRunAttempt()
      Indicates how run attempts are to be pulled.
      int getRunAttemptValue()
      Indicates how run attempts are to be pulled.
      TransferState getStates​(int index)
      When specified, only transfer runs with requested states are returned.
      int getStatesCount()
      When specified, only transfer runs with requested states are returned.
      List<TransferState> getStatesList()
      When specified, only transfer runs with requested states are returned.
      int getStatesValue​(int index)
      When specified, only transfer runs with requested states are returned.
      List<Integer> getStatesValueList()
      When specified, only transfer runs with requested states are returned.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        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:
        The parent.

      • getParentBytes

        com.google.protobuf.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:
        The bytes for parent.

      • getStatesList

        List<TransferState> getStatesList()
         When specified, only transfer runs with requested states are returned.
        repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
        Returns:
        A list containing the states.

      • getStatesCount

        int getStatesCount()
         When specified, only transfer runs with requested states are returned.
        repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
        Returns:
        The count of states.

      • getStates

        TransferState getStates​(int index)
         When specified, only transfer runs with requested states are returned.
        repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
        Parameters:
        index - The index of the element to return.
        Returns:
        The states at the given index.

      • getStatesValueList

        List<Integer> getStatesValueList()
         When specified, only transfer runs with requested states are returned.
        repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
        Returns:
        A list containing the enum numeric values on the wire for states.

      • getStatesValue

        int getStatesValue​(int index)
         When specified, only transfer runs with requested states are returned.
        repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of states at the given index.

      • getPageToken

        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:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.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:
        The bytes for pageToken.

      • getPageSize

        int getPageSize()
         Page size. The default page size is the maximum value of 1000 results.
        int32 page_size = 4;
        Returns:
        The pageSize.

      • getRunAttemptValue

        int getRunAttemptValue()
         Indicates how run attempts are to be pulled.
        .google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;
        Returns:
        The enum numeric value on the wire for runAttempt.

      • getRunAttempt

        ListTransferRunsRequest.RunAttempt getRunAttempt()
         Indicates how run attempts are to be pulled.
        .google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt run_attempt = 5;
        Returns:
        The runAttempt.