Console
    Contact Us Start free

    Google Cloud Storage Transfer V1 Client - Class TransferOperation (1.3.1)

    Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class TransferOperation.

    A description of the execution of a transfer.

    Generated from protobuf message google.storagetransfer.v1.TransferOperation

    Namespace

    Google \ Cloud \ StorageTransfer \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    A globally unique ID assigned by the system.

    ↳ project_id
    string

    The ID of the Google Cloud project that owns the operation.

    ↳ transfer_spec
    Google\Cloud\StorageTransfer\V1\TransferSpec

    Transfer specification.

    ↳ notification_config
    Google\Cloud\StorageTransfer\V1\NotificationConfig

    Notification configuration.

    ↳ logging_config
    Google\Cloud\StorageTransfer\V1\LoggingConfig

    Cloud Logging configuration.

    ↳ start_time
    Google\Protobuf\Timestamp

    Start time of this transfer execution.

    ↳ end_time
    Google\Protobuf\Timestamp

    End time of this transfer execution.

    ↳ status
    int

    Status of the transfer operation.

    ↳ counters
    Google\Cloud\StorageTransfer\V1\TransferCounters

    Information about the progress of the transfer operation.

    ↳ error_breakdowns
    array< Google\Cloud\StorageTransfer\V1\ErrorSummary >

    Summarizes errors encountered with sample error log entries.

    ↳ transfer_job_name
    string

    The name of the transfer job that triggers this transfer operation.

    getName

    A globally unique ID assigned by the system.

    Returns
    Type
    Description
    string

    setName

    A globally unique ID assigned by the system.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getProjectId

    The ID of the Google Cloud project that owns the operation.

    Returns
    Type
    Description
    string

    setProjectId

    The ID of the Google Cloud project that owns the operation.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getTransferSpec

    Transfer specification.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\TransferSpec |null

    hasTransferSpec

    clearTransferSpec

    setTransferSpec

    Transfer specification.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\TransferSpec
    Returns
    Type
    Description
    $this

    getNotificationConfig

    Notification configuration.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\NotificationConfig |null

    hasNotificationConfig

    clearNotificationConfig

    setNotificationConfig

    Notification configuration.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\NotificationConfig
    Returns
    Type
    Description
    $this

    getLoggingConfig

    Cloud Logging configuration.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\LoggingConfig |null

    hasLoggingConfig

    clearLoggingConfig

    setLoggingConfig

    Cloud Logging configuration.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\LoggingConfig
    Returns
    Type
    Description
    $this

    getStartTime

    Start time of this transfer execution.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasStartTime

    clearStartTime

    setStartTime

    Start time of this transfer execution.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getEndTime

    End time of this transfer execution.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasEndTime

    clearEndTime

    setEndTime

    End time of this transfer execution.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getStatus

    Status of the transfer operation.

    Returns
    Type
    Description
    int

    setStatus

    Status of the transfer operation.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getCounters

    Information about the progress of the transfer operation.

    Returns
    Type
    Description
    Google\Cloud\StorageTransfer\V1\TransferCounters |null

    hasCounters

    clearCounters

    setCounters

    Information about the progress of the transfer operation.

    Parameter
    Name
    Description
    var
    Google\Cloud\StorageTransfer\V1\TransferCounters
    Returns
    Type
    Description
    $this

    getErrorBreakdowns

    Summarizes errors encountered with sample error log entries.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setErrorBreakdowns

    Summarizes errors encountered with sample error log entries.

    Parameter
    Name
    Description
    var
    array< Google\Cloud\StorageTransfer\V1\ErrorSummary >
    Returns
    Type
    Description
    $this

    getTransferJobName

    The name of the transfer job that triggers this transfer operation.

    Returns
    Type
    Description
    string

    setTransferJobName

    The name of the transfer job that triggers this transfer operation.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: