Class: Google::Cloud::Dataplex::V1::EncryptionConfig

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

Overview

A Resource designed to manage encryption configurations for customers to support Customer Managed Encryption Keys (CMEK).

Defined Under Namespace

Modules: EncryptionState Classes: FailureDetails

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly) 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dataplex/v1/cmek.rb', line 52

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

  # Details of the failure if anything related to Cmek db fails.
  # @!attribute [r] error_code
  #   @return [::Google::Cloud::Dataplex::V1::EncryptionConfig::FailureDetails::ErrorCode]
  #     Output only. The error code for the failure.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message will be shown to the user. Set only if the
  #     error code is REQUIRE_USER_ACTION.
  class FailureDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Error code for the failure if anything related to Cmek db fails.
    module ErrorCode
      # The error code is not specified
      UNKNOWN = 0

      # Error because of internal server error, will be retried automatically.
      INTERNAL_ERROR = 1

      # User action is required to resolve the error.
      REQUIRE_USER_ACTION = 2
    end
  end

  # State of encryption of the databases when EncryptionConfig is created or
  # updated.
  module EncryptionState
    # State is not specified.
    ENCRYPTION_STATE_UNSPECIFIED = 0

    # The encryption state of the database when the EncryptionConfig is created
    # or updated. If the encryption fails, it is retried indefinitely and the
    # state is shown as ENCRYPTING.
    ENCRYPTING = 1

    # The encryption of data has completed successfully.
    COMPLETED = 2

    # The encryption of data has failed.
    # The state is set to FAILED when the encryption fails due to reasons like
    # permission issues, invalid key etc.
    FAILED = 3
  end
end

#encryption_state ⇒ ::Google::Cloud::Dataplex::V1::EncryptionConfig::EncryptionState (readonly) 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dataplex/v1/cmek.rb', line 52

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

  # Details of the failure if anything related to Cmek db fails.
  # @!attribute [r] error_code
  #   @return [::Google::Cloud::Dataplex::V1::EncryptionConfig::FailureDetails::ErrorCode]
  #     Output only. The error code for the failure.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message will be shown to the user. Set only if the
  #     error code is REQUIRE_USER_ACTION.
  class FailureDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Error code for the failure if anything related to Cmek db fails.
    module ErrorCode
      # The error code is not specified
      UNKNOWN = 0

      # Error because of internal server error, will be retried automatically.
      INTERNAL_ERROR = 1

      # User action is required to resolve the error.
      REQUIRE_USER_ACTION = 2
    end
  end

  # State of encryption of the databases when EncryptionConfig is created or
  # updated.
  module EncryptionState
    # State is not specified.
    ENCRYPTION_STATE_UNSPECIFIED = 0

    # The encryption state of the database when the EncryptionConfig is created
    # or updated. If the encryption fails, it is retried indefinitely and the
    # state is shown as ENCRYPTING.
    ENCRYPTING = 1

    # The encryption of data has completed successfully.
    COMPLETED = 2

    # The encryption of data has failed.
    # The state is set to FAILED when the encryption fails due to reasons like
    # permission issues, invalid key etc.
    FAILED = 3
  end
end

#etag ⇒ ::String 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dataplex/v1/cmek.rb', line 52

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

  # Details of the failure if anything related to Cmek db fails.
  # @!attribute [r] error_code
  #   @return [::Google::Cloud::Dataplex::V1::EncryptionConfig::FailureDetails::ErrorCode]
  #     Output only. The error code for the failure.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message will be shown to the user. Set only if the
  #     error code is REQUIRE_USER_ACTION.
  class FailureDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Error code for the failure if anything related to Cmek db fails.
    module ErrorCode
      # The error code is not specified
      UNKNOWN = 0

      # Error because of internal server error, will be retried automatically.
      INTERNAL_ERROR = 1

      # User action is required to resolve the error.
      REQUIRE_USER_ACTION = 2
    end
  end

  # State of encryption of the databases when EncryptionConfig is created or
  # updated.
  module EncryptionState
    # State is not specified.
    ENCRYPTION_STATE_UNSPECIFIED = 0

    # The encryption state of the database when the EncryptionConfig is created
    # or updated. If the encryption fails, it is retried indefinitely and the
    # state is shown as ENCRYPTING.
    ENCRYPTING = 1

    # The encryption of data has completed successfully.
    COMPLETED = 2

    # The encryption of data has failed.
    # The state is set to FAILED when the encryption fails due to reasons like
    # permission issues, invalid key etc.
    FAILED = 3
  end
end

#failure_details ⇒ ::Google::Cloud::Dataplex::V1::EncryptionConfig::FailureDetails (readonly) 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dataplex/v1/cmek.rb', line 52

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

  # Details of the failure if anything related to Cmek db fails.
  # @!attribute [r] error_code
  #   @return [::Google::Cloud::Dataplex::V1::EncryptionConfig::FailureDetails::ErrorCode]
  #     Output only. The error code for the failure.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message will be shown to the user. Set only if the
  #     error code is REQUIRE_USER_ACTION.
  class FailureDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Error code for the failure if anything related to Cmek db fails.
    module ErrorCode
      # The error code is not specified
      UNKNOWN = 0

      # Error because of internal server error, will be retried automatically.
      INTERNAL_ERROR = 1

      # User action is required to resolve the error.
      REQUIRE_USER_ACTION = 2
    end
  end

  # State of encryption of the databases when EncryptionConfig is created or
  # updated.
  module EncryptionState
    # State is not specified.
    ENCRYPTION_STATE_UNSPECIFIED = 0

    # The encryption state of the database when the EncryptionConfig is created
    # or updated. If the encryption fails, it is retried indefinitely and the
    # state is shown as ENCRYPTING.
    ENCRYPTING = 1

    # The encryption of data has completed successfully.
    COMPLETED = 2

    # The encryption of data has failed.
    # The state is set to FAILED when the encryption fails due to reasons like
    # permission issues, invalid key etc.
    FAILED = 3
  end
end

#key ⇒ ::String 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dataplex/v1/cmek.rb', line 52

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

  # Details of the failure if anything related to Cmek db fails.
  # @!attribute [r] error_code
  #   @return [::Google::Cloud::Dataplex::V1::EncryptionConfig::FailureDetails::ErrorCode]
  #     Output only. The error code for the failure.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message will be shown to the user. Set only if the
  #     error code is REQUIRE_USER_ACTION.
  class FailureDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Error code for the failure if anything related to Cmek db fails.
    module ErrorCode
      # The error code is not specified
      UNKNOWN = 0

      # Error because of internal server error, will be retried automatically.
      INTERNAL_ERROR = 1

      # User action is required to resolve the error.
      REQUIRE_USER_ACTION = 2
    end
  end

  # State of encryption of the databases when EncryptionConfig is created or
  # updated.
  module EncryptionState
    # State is not specified.
    ENCRYPTION_STATE_UNSPECIFIED = 0

    # The encryption state of the database when the EncryptionConfig is created
    # or updated. If the encryption fails, it is retried indefinitely and the
    # state is shown as ENCRYPTING.
    ENCRYPTING = 1

    # The encryption of data has completed successfully.
    COMPLETED = 2

    # The encryption of data has failed.
    # The state is set to FAILED when the encryption fails due to reasons like
    # permission issues, invalid key etc.
    FAILED = 3
  end
end

#name ⇒ ::String 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dataplex/v1/cmek.rb', line 52

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

  # Details of the failure if anything related to Cmek db fails.
  # @!attribute [r] error_code
  #   @return [::Google::Cloud::Dataplex::V1::EncryptionConfig::FailureDetails::ErrorCode]
  #     Output only. The error code for the failure.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message will be shown to the user. Set only if the
  #     error code is REQUIRE_USER_ACTION.
  class FailureDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Error code for the failure if anything related to Cmek db fails.
    module ErrorCode
      # The error code is not specified
      UNKNOWN = 0

      # Error because of internal server error, will be retried automatically.
      INTERNAL_ERROR = 1

      # User action is required to resolve the error.
      REQUIRE_USER_ACTION = 2
    end
  end

  # State of encryption of the databases when EncryptionConfig is created or
  # updated.
  module EncryptionState
    # State is not specified.
    ENCRYPTION_STATE_UNSPECIFIED = 0

    # The encryption state of the database when the EncryptionConfig is created
    # or updated. If the encryption fails, it is retried indefinitely and the
    # state is shown as ENCRYPTING.
    ENCRYPTING = 1

    # The encryption of data has completed successfully.
    COMPLETED = 2

    # The encryption of data has failed.
    # The state is set to FAILED when the encryption fails due to reasons like
    # permission issues, invalid key etc.
    FAILED = 3
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly) 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'proto_docs/google/cloud/dataplex/v1/cmek.rb', line 52

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

  # Details of the failure if anything related to Cmek db fails.
  # @!attribute [r] error_code
  #   @return [::Google::Cloud::Dataplex::V1::EncryptionConfig::FailureDetails::ErrorCode]
  #     Output only. The error code for the failure.
  # @!attribute [r] error_message
  #   @return [::String]
  #     Output only. The error message will be shown to the user. Set only if the
  #     error code is REQUIRE_USER_ACTION.
  class FailureDetails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Error code for the failure if anything related to Cmek db fails.
    module ErrorCode
      # The error code is not specified
      UNKNOWN = 0

      # Error because of internal server error, will be retried automatically.
      INTERNAL_ERROR = 1

      # User action is required to resolve the error.
      REQUIRE_USER_ACTION = 2
    end
  end

  # State of encryption of the databases when EncryptionConfig is created or
  # updated.
  module EncryptionState
    # State is not specified.
    ENCRYPTION_STATE_UNSPECIFIED = 0

    # The encryption state of the database when the EncryptionConfig is created
    # or updated. If the encryption fails, it is retried indefinitely and the
    # state is shown as ENCRYPTING.
    ENCRYPTING = 1

    # The encryption of data has completed successfully.
    COMPLETED = 2

    # The encryption of data has failed.
    # The state is set to FAILED when the encryption fails due to reasons like
    # permission issues, invalid key etc.
    FAILED = 3
  end
end