Class: Google::Cloud::CloudDMS::V1::ConnectionProfile

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

Overview

A connection profile definition.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#alloydb ⇒ ::Google::Cloud::CloudDMS::V1::AlloyDbConnectionProfile

Returns An AlloyDB cluster connection profile.

Note: The following fields are mutually exclusive: alloydb, mysql, postgresql, oracle, cloudsql. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::AlloyDbConnectionProfile) —

    An AlloyDB cluster connection profile.

    Note: The following fields are mutually exclusive: alloydb, mysql, postgresql, oracle, cloudsql. If a field in that set is populated, all other fields in the set will automatically be cleared.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#cloudsql ⇒ ::Google::Cloud::CloudDMS::V1::CloudSqlConnectionProfile

Returns A CloudSQL database connection profile.

Note: The following fields are mutually exclusive: cloudsql, mysql, postgresql, oracle, alloydb. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::CloudSqlConnectionProfile) —

    A CloudSQL database connection profile.

    Note: The following fields are mutually exclusive: cloudsql, mysql, postgresql, oracle, alloydb. If a field in that set is populated, all other fields in the set will automatically be cleared.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

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

Returns Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#display_name ⇒ ::String

Returns The connection profile display name.

Returns:

  • (::String) —

    The connection profile display name.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#error ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. The error details in case of state FAILED.

Returns:



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.

    Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#mysql ⇒ ::Google::Cloud::CloudDMS::V1::MySqlConnectionProfile

Returns A MySQL database connection profile.

Note: The following fields are mutually exclusive: mysql, postgresql, oracle, cloudsql, alloydb. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::MySqlConnectionProfile) —

    A MySQL database connection profile.

    Note: The following fields are mutually exclusive: mysql, postgresql, oracle, cloudsql, alloydb. If a field in that set is populated, all other fields in the set will automatically be cleared.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#name ⇒ ::String

Returns The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.

Returns:

  • (::String) —

    The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#oracle ⇒ ::Google::Cloud::CloudDMS::V1::OracleConnectionProfile

Returns An Oracle database connection profile.

Note: The following fields are mutually exclusive: oracle, mysql, postgresql, cloudsql, alloydb. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::OracleConnectionProfile) —

    An Oracle database connection profile.

    Note: The following fields are mutually exclusive: oracle, mysql, postgresql, cloudsql, alloydb. If a field in that set is populated, all other fields in the set will automatically be cleared.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#postgresql ⇒ ::Google::Cloud::CloudDMS::V1::PostgreSqlConnectionProfile

Returns A PostgreSQL database connection profile.

Note: The following fields are mutually exclusive: postgresql, mysql, oracle, cloudsql, alloydb. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::CloudDMS::V1::PostgreSqlConnectionProfile) —

    A PostgreSQL database connection profile.

    Note: The following fields are mutually exclusive: postgresql, mysql, oracle, cloudsql, alloydb. If a field in that set is populated, all other fields in the set will automatically be cleared.



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#provider ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseProvider

Returns The database provider.

Returns:



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

#state ⇒ ::Google::Cloud::CloudDMS::V1::ConnectionProfile::State

Returns The current connection profile state (e.g. DRAFT, READY, or FAILED).

Returns:



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end

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

Returns Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb', line 1045

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The current connection profile state (e.g. DRAFT, READY, or FAILED).
  module State
    # The state of the connection profile is unknown.
    STATE_UNSPECIFIED = 0

    # The connection profile is in draft mode and fully editable.
    DRAFT = 1

    # The connection profile is being created.
    CREATING = 2

    # The connection profile is ready.
    READY = 3

    # The connection profile is being updated.
    UPDATING = 4

    # The connection profile is being deleted.
    DELETING = 5

    # The connection profile has been deleted.
    DELETED = 6

    # The last action on the connection profile failed.
    FAILED = 7
  end
end