Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::CloneContext (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::CloneContext.

Database instance clone context.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allocated_ip_range

def allocated_ip_range() -> ::String
Returns
  • (::String) — The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. Reserved for future use.

#allocated_ip_range=

def allocated_ip_range=(value) -> ::String
Parameter
  • value (::String) — The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. Reserved for future use.
Returns
  • (::String) — The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. Reserved for future use.

#bin_log_coordinates

def bin_log_coordinates() -> ::Google::Cloud::Sql::V1::BinLogCoordinates
Returns
  • (::Google::Cloud::Sql::V1::BinLogCoordinates) — Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.

#bin_log_coordinates=

def bin_log_coordinates=(value) -> ::Google::Cloud::Sql::V1::BinLogCoordinates
Parameter
  • value (::Google::Cloud::Sql::V1::BinLogCoordinates) — Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
Returns
  • (::Google::Cloud::Sql::V1::BinLogCoordinates) — Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.

#database_names

def database_names() -> ::Array<::String>
Returns
  • (::Array<::String>) — (SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.

#database_names=

def database_names=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — (SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.
Returns
  • (::Array<::String>) — (SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.

#destination_instance_name

def destination_instance_name() -> ::String
Returns
  • (::String) — Required. Name of the Cloud SQL instance to be created as a clone.

#destination_instance_name=

def destination_instance_name=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the Cloud SQL instance to be created as a clone.
Returns
  • (::String) — Required. Name of the Cloud SQL instance to be created as a clone.

#destination_network

def destination_network() -> ::String
Returns
  • (::String) — Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:projects/my-network-project/global/networks/my-network. This field is only required for cross-project cloning.

#destination_network=

def destination_network=(value) -> ::String
Parameter
  • value (::String) — Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:projects/my-network-project/global/networks/my-network. This field is only required for cross-project cloning.
Returns
  • (::String) — Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:projects/my-network-project/global/networks/my-network. This field is only required for cross-project cloning.

#destination_project

def destination_project() -> ::String
Returns
  • (::String) — Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.

#destination_project=

def destination_project=(value) -> ::String
Parameter
  • value (::String) — Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.
Returns
  • (::String) — Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.

#kind

def kind() -> ::String
Returns
  • (::String) — This is always sql#cloneContext.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — This is always sql#cloneContext.
Returns
  • (::String) — This is always sql#cloneContext.

#pitr_timestamp_ms

def pitr_timestamp_ms() -> ::Integer
Returns
  • (::Integer) — Reserved for future use.

#pitr_timestamp_ms=

def pitr_timestamp_ms=(value) -> ::Integer
Parameter
  • value (::Integer) — Reserved for future use.
Returns
  • (::Integer) — Reserved for future use.

#point_in_time

def point_in_time() -> ::Google::Protobuf::Timestamp
Returns

#point_in_time=

def point_in_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#preferred_secondary_zone

def preferred_secondary_zone() -> ::String
Returns
  • (::String) — Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. This field applies to all DB types.

#preferred_secondary_zone=

def preferred_secondary_zone=(value) -> ::String
Parameter
  • value (::String) — Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. This field applies to all DB types.
Returns
  • (::String) — Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. This field applies to all DB types.

#preferred_zone

def preferred_zone() -> ::String
Returns
  • (::String) — Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.

#preferred_zone=

def preferred_zone=(value) -> ::String
Parameter
  • value (::String) — Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.
Returns
  • (::String) — Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.

#source_instance_deletion_time

def source_instance_deletion_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.

#source_instance_deletion_time=

def source_instance_deletion_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.
Returns
  • (::Google::Protobuf::Timestamp) — The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.