Class ListTransferRunsRequest

  • All Implemented Interfaces:
    ListTransferRunsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ListTransferRunsRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements ListTransferRunsRequestOrBuilder
     A request to list data transfer runs.
     
    Protobuf type google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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) = { ... }
        Specified by:
        getParent in interface ListTransferRunsRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface ListTransferRunsRequestOrBuilder
        Returns:
        The bytes for parent.
      • getStatesList

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

        public int getStatesCount()
         When specified, only transfer runs with requested states are returned.
         
        repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
        Specified by:
        getStatesCount in interface ListTransferRunsRequestOrBuilder
        Returns:
        The count of states.
      • getStates

        public TransferState getStates​(int index)
         When specified, only transfer runs with requested states are returned.
         
        repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
        Specified by:
        getStates in interface ListTransferRunsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The 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;
        Specified by:
        getStatesValueList in interface ListTransferRunsRequestOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for states.
      • getStatesValue

        public int getStatesValue​(int index)
         When specified, only transfer runs with requested states are returned.
         
        repeated .google.cloud.bigquery.datatransfer.v1.TransferState states = 2;
        Specified by:
        getStatesValue in interface ListTransferRunsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of states at the given index.
      • 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;
        Specified by:
        getPageToken in interface ListTransferRunsRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public 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;
        Specified by:
        getPageTokenBytes in interface ListTransferRunsRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • getPageSize

        public int getPageSize()
         Page size. The default page size is the maximum value of 1000 results.
         
        int32 page_size = 4;
        Specified by:
        getPageSize in interface ListTransferRunsRequestOrBuilder
        Returns:
        The pageSize.
      • getRunAttemptValue

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

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static ListTransferRunsRequest parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ListTransferRunsRequest parseFrom​(ByteBuffer data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ListTransferRunsRequest parseFrom​(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ListTransferRunsRequest parseFrom​(com.google.protobuf.ByteString data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ListTransferRunsRequest parseFrom​(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static ListTransferRunsRequest parseFrom​(byte[] data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public ListTransferRunsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public ListTransferRunsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected ListTransferRunsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<ListTransferRunsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public ListTransferRunsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder