Class: Google::Cloud::StorageTransfer::V1::S3CompatibleMetadata

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

Overview

S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.

Defined Under Namespace

Modules: AuthMethod, ListApi, NetworkProtocol, RequestModel

Instance Attribute Summary collapse

Instance Attribute Details

#auth_method ⇒ ::Google::Cloud::StorageTransfer::V1::S3CompatibleMetadata::AuthMethod

Returns Specifies the authentication and authorization method used by the storage service. When not specified, Transfer Service will attempt to determine right auth method to use.

Returns:



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 516

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

  # The authentication and authorization method used by the storage service.
  module AuthMethod
    # AuthMethod is not specified.
    AUTH_METHOD_UNSPECIFIED = 0

    # Auth requests with AWS SigV4.
    AUTH_METHOD_AWS_SIGNATURE_V4 = 1

    # Auth requests with AWS SigV2.
    AUTH_METHOD_AWS_SIGNATURE_V2 = 2
  end

  # The request model of the API.
  module RequestModel
    # RequestModel is not specified.
    REQUEST_MODEL_UNSPECIFIED = 0

    # Perform requests using Virtual Hosted Style.
    # Example: https://bucket-name.s3.region.amazonaws.com/key-name
    REQUEST_MODEL_VIRTUAL_HOSTED_STYLE = 1

    # Perform requests using Path Style.
    # Example: https://s3.region.amazonaws.com/bucket-name/key-name
    REQUEST_MODEL_PATH_STYLE = 2
  end

  # The agent network protocol to access the storage service.
  module NetworkProtocol
    # NetworkProtocol is not specified.
    NETWORK_PROTOCOL_UNSPECIFIED = 0

    # Perform requests using HTTPS.
    NETWORK_PROTOCOL_HTTPS = 1

    # Not recommended: This sends data in clear-text. This is only
    # appropriate within a closed network or for publicly available data.
    # Perform requests using HTTP.
    NETWORK_PROTOCOL_HTTP = 2
  end

  # The Listing API to use for discovering objects.
  module ListApi
    # ListApi is not specified.
    LIST_API_UNSPECIFIED = 0

    # Perform listing using ListObjectsV2 API.
    LIST_OBJECTS_V2 = 1

    # Legacy ListObjects API.
    LIST_OBJECTS = 2
  end
end

#list_api ⇒ ::Google::Cloud::StorageTransfer::V1::S3CompatibleMetadata::ListApi

Returns The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.

Returns:



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 516

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

  # The authentication and authorization method used by the storage service.
  module AuthMethod
    # AuthMethod is not specified.
    AUTH_METHOD_UNSPECIFIED = 0

    # Auth requests with AWS SigV4.
    AUTH_METHOD_AWS_SIGNATURE_V4 = 1

    # Auth requests with AWS SigV2.
    AUTH_METHOD_AWS_SIGNATURE_V2 = 2
  end

  # The request model of the API.
  module RequestModel
    # RequestModel is not specified.
    REQUEST_MODEL_UNSPECIFIED = 0

    # Perform requests using Virtual Hosted Style.
    # Example: https://bucket-name.s3.region.amazonaws.com/key-name
    REQUEST_MODEL_VIRTUAL_HOSTED_STYLE = 1

    # Perform requests using Path Style.
    # Example: https://s3.region.amazonaws.com/bucket-name/key-name
    REQUEST_MODEL_PATH_STYLE = 2
  end

  # The agent network protocol to access the storage service.
  module NetworkProtocol
    # NetworkProtocol is not specified.
    NETWORK_PROTOCOL_UNSPECIFIED = 0

    # Perform requests using HTTPS.
    NETWORK_PROTOCOL_HTTPS = 1

    # Not recommended: This sends data in clear-text. This is only
    # appropriate within a closed network or for publicly available data.
    # Perform requests using HTTP.
    NETWORK_PROTOCOL_HTTP = 2
  end

  # The Listing API to use for discovering objects.
  module ListApi
    # ListApi is not specified.
    LIST_API_UNSPECIFIED = 0

    # Perform listing using ListObjectsV2 API.
    LIST_OBJECTS_V2 = 1

    # Legacy ListObjects API.
    LIST_OBJECTS = 2
  end
end

#protocol ⇒ ::Google::Cloud::StorageTransfer::V1::S3CompatibleMetadata::NetworkProtocol

Returns Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.

Returns:



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 516

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

  # The authentication and authorization method used by the storage service.
  module AuthMethod
    # AuthMethod is not specified.
    AUTH_METHOD_UNSPECIFIED = 0

    # Auth requests with AWS SigV4.
    AUTH_METHOD_AWS_SIGNATURE_V4 = 1

    # Auth requests with AWS SigV2.
    AUTH_METHOD_AWS_SIGNATURE_V2 = 2
  end

  # The request model of the API.
  module RequestModel
    # RequestModel is not specified.
    REQUEST_MODEL_UNSPECIFIED = 0

    # Perform requests using Virtual Hosted Style.
    # Example: https://bucket-name.s3.region.amazonaws.com/key-name
    REQUEST_MODEL_VIRTUAL_HOSTED_STYLE = 1

    # Perform requests using Path Style.
    # Example: https://s3.region.amazonaws.com/bucket-name/key-name
    REQUEST_MODEL_PATH_STYLE = 2
  end

  # The agent network protocol to access the storage service.
  module NetworkProtocol
    # NetworkProtocol is not specified.
    NETWORK_PROTOCOL_UNSPECIFIED = 0

    # Perform requests using HTTPS.
    NETWORK_PROTOCOL_HTTPS = 1

    # Not recommended: This sends data in clear-text. This is only
    # appropriate within a closed network or for publicly available data.
    # Perform requests using HTTP.
    NETWORK_PROTOCOL_HTTP = 2
  end

  # The Listing API to use for discovering objects.
  module ListApi
    # ListApi is not specified.
    LIST_API_UNSPECIFIED = 0

    # Perform listing using ListObjectsV2 API.
    LIST_OBJECTS_V2 = 1

    # Legacy ListObjects API.
    LIST_OBJECTS = 2
  end
end

#request_model ⇒ ::Google::Cloud::StorageTransfer::V1::S3CompatibleMetadata::RequestModel

Returns Specifies the API request model used to call the storage service. When not specified, the default value of RequestModel REQUEST_MODEL_VIRTUAL_HOSTED_STYLE is used.

Returns:



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 516

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

  # The authentication and authorization method used by the storage service.
  module AuthMethod
    # AuthMethod is not specified.
    AUTH_METHOD_UNSPECIFIED = 0

    # Auth requests with AWS SigV4.
    AUTH_METHOD_AWS_SIGNATURE_V4 = 1

    # Auth requests with AWS SigV2.
    AUTH_METHOD_AWS_SIGNATURE_V2 = 2
  end

  # The request model of the API.
  module RequestModel
    # RequestModel is not specified.
    REQUEST_MODEL_UNSPECIFIED = 0

    # Perform requests using Virtual Hosted Style.
    # Example: https://bucket-name.s3.region.amazonaws.com/key-name
    REQUEST_MODEL_VIRTUAL_HOSTED_STYLE = 1

    # Perform requests using Path Style.
    # Example: https://s3.region.amazonaws.com/bucket-name/key-name
    REQUEST_MODEL_PATH_STYLE = 2
  end

  # The agent network protocol to access the storage service.
  module NetworkProtocol
    # NetworkProtocol is not specified.
    NETWORK_PROTOCOL_UNSPECIFIED = 0

    # Perform requests using HTTPS.
    NETWORK_PROTOCOL_HTTPS = 1

    # Not recommended: This sends data in clear-text. This is only
    # appropriate within a closed network or for publicly available data.
    # Perform requests using HTTP.
    NETWORK_PROTOCOL_HTTP = 2
  end

  # The Listing API to use for discovering objects.
  module ListApi
    # ListApi is not specified.
    LIST_API_UNSPECIFIED = 0

    # Perform listing using ListObjectsV2 API.
    LIST_OBJECTS_V2 = 1

    # Legacy ListObjects API.
    LIST_OBJECTS = 2
  end
end