Class: Google::Cloud::StorageTransfer::V1::LoggingConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer_types.rb

Overview

Specifies the logging behavior for transfer operations.

Logs can be sent to Cloud Logging for all transfer types. See Read transfer logs for details.

Defined Under Namespace

Modules: LoggableAction, LoggableActionState

Instance Attribute Summary collapse

Instance Attribute Details

#enable_onprem_gcs_transfer_logs ⇒ ::Boolean

Returns For PosixFilesystem transfers, enables file system transfer logs instead of, or in addition to, Cloud Logging.

This option ignores [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging will also be enabled for this transfer.

Returns:

  • (::Boolean) —

    For PosixFilesystem transfers, enables file system transfer logs instead of, or in addition to, Cloud Logging.

    This option ignores [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging will also be enabled for this transfer.



1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1427

class LoggingConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Loggable actions.
  module LoggableAction
    # Default value. This value is unused.
    LOGGABLE_ACTION_UNSPECIFIED = 0

    # Listing objects in a bucket.
    FIND = 1

    # Deleting objects at the source or the destination.
    DELETE = 2

    # Copying objects to the destination.
    COPY = 3
  end

  # Loggable action states.
  module LoggableActionState
    # Default value. This value is unused.
    LOGGABLE_ACTION_STATE_UNSPECIFIED = 0

    # `LoggableAction` completed successfully. `SUCCEEDED` actions are
    # logged as [INFO][google.logging.type.LogSeverity.INFO].
    SUCCEEDED = 1

    # `LoggableAction` terminated in an error state. `FAILED` actions are
    # logged as [ERROR][google.logging.type.LogSeverity.ERROR].
    FAILED = 2

    # The `COPY` action was skipped for this file. Only supported for
    # agent-based transfers. `SKIPPED` actions are
    # logged as [INFO][google.logging.type.LogSeverity.INFO].
    SKIPPED = 3
  end
end

#log_action_states ⇒ ::Array<::Google::Cloud::StorageTransfer::V1::LoggingConfig::LoggableActionState>

Returns States in which log_actions are logged. If empty, no logs are generated.

Returns:



1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1427

class LoggingConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Loggable actions.
  module LoggableAction
    # Default value. This value is unused.
    LOGGABLE_ACTION_UNSPECIFIED = 0

    # Listing objects in a bucket.
    FIND = 1

    # Deleting objects at the source or the destination.
    DELETE = 2

    # Copying objects to the destination.
    COPY = 3
  end

  # Loggable action states.
  module LoggableActionState
    # Default value. This value is unused.
    LOGGABLE_ACTION_STATE_UNSPECIFIED = 0

    # `LoggableAction` completed successfully. `SUCCEEDED` actions are
    # logged as [INFO][google.logging.type.LogSeverity.INFO].
    SUCCEEDED = 1

    # `LoggableAction` terminated in an error state. `FAILED` actions are
    # logged as [ERROR][google.logging.type.LogSeverity.ERROR].
    FAILED = 2

    # The `COPY` action was skipped for this file. Only supported for
    # agent-based transfers. `SKIPPED` actions are
    # logged as [INFO][google.logging.type.LogSeverity.INFO].
    SKIPPED = 3
  end
end

#log_actions ⇒ ::Array<::Google::Cloud::StorageTransfer::V1::LoggingConfig::LoggableAction>

Returns Specifies the actions to be logged. If empty, no logs are generated.

Returns:



1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1427

class LoggingConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Loggable actions.
  module LoggableAction
    # Default value. This value is unused.
    LOGGABLE_ACTION_UNSPECIFIED = 0

    # Listing objects in a bucket.
    FIND = 1

    # Deleting objects at the source or the destination.
    DELETE = 2

    # Copying objects to the destination.
    COPY = 3
  end

  # Loggable action states.
  module LoggableActionState
    # Default value. This value is unused.
    LOGGABLE_ACTION_STATE_UNSPECIFIED = 0

    # `LoggableAction` completed successfully. `SUCCEEDED` actions are
    # logged as [INFO][google.logging.type.LogSeverity.INFO].
    SUCCEEDED = 1

    # `LoggableAction` terminated in an error state. `FAILED` actions are
    # logged as [ERROR][google.logging.type.LogSeverity.ERROR].
    FAILED = 2

    # The `COPY` action was skipped for this file. Only supported for
    # agent-based transfers. `SKIPPED` actions are
    # logged as [INFO][google.logging.type.LogSeverity.INFO].
    SKIPPED = 3
  end
end