Interface CloneContextOrBuilder (0.1.0)

public interface CloneContextOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllocatedIpRange()

public abstract String getAllocatedIpRange()

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.

string allocated_ip_range = 6;

Returns
Type	Description
String	The allocatedIpRange.

getAllocatedIpRangeBytes()

public abstract ByteString getAllocatedIpRangeBytes()

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.

string allocated_ip_range = 6;

Returns
Type	Description
ByteString	The bytes for allocatedIpRange.

getBinLogCoordinates()

public abstract BinLogCoordinates getBinLogCoordinates()

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.

.google.cloud.sql.v1.BinLogCoordinates bin_log_coordinates = 4;

Returns
Type	Description
BinLogCoordinates	The binLogCoordinates.

getBinLogCoordinatesOrBuilder()

public abstract BinLogCoordinatesOrBuilder getBinLogCoordinatesOrBuilder()

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.

.google.cloud.sql.v1.BinLogCoordinates bin_log_coordinates = 4;

Returns
Type	Description
BinLogCoordinatesOrBuilder

getDatabaseNames(int index)

public abstract String getDatabaseNames(int index)

(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.

repeated string database_names = 9;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The databaseNames at the given index.

getDatabaseNamesBytes(int index)

public abstract ByteString getDatabaseNamesBytes(int index)

(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.

repeated string database_names = 9;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the databaseNames at the given index.

getDatabaseNamesCount()

public abstract int getDatabaseNamesCount()

(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.

repeated string database_names = 9;

Returns
Type	Description
int	The count of databaseNames.

getDatabaseNamesList()

public abstract List<String> getDatabaseNamesList()

(SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.

repeated string database_names = 9;

Returns
Type	Description
List<String>	A list containing the databaseNames.

getDestinationInstanceName()

public abstract String getDestinationInstanceName()

Required. Name of the Cloud SQL instance to be created as a clone.

string destination_instance_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The destinationInstanceName.

getDestinationInstanceNameBytes()

public abstract ByteString getDestinationInstanceNameBytes()

Required. Name of the Cloud SQL instance to be created as a clone.

string destination_instance_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for destinationInstanceName.

getDestinationNetwork()

public abstract String getDestinationNetwork()

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.

optional string destination_network = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The destinationNetwork.

getDestinationNetworkBytes()

public abstract ByteString getDestinationNetworkBytes()

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.

optional string destination_network = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for destinationNetwork.

getDestinationProject()

public abstract String getDestinationProject()

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.

optional string destination_project = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The destinationProject.

getDestinationProjectBytes()

public abstract ByteString getDestinationProjectBytes()

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.

optional string destination_project = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for destinationProject.

getKind()

public abstract String getKind()

This is always sql#cloneContext.

string kind = 1;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

This is always sql#cloneContext.

string kind = 1;

Returns
Type	Description
ByteString	The bytes for kind.

getPitrTimestampMs()

public abstract long getPitrTimestampMs()

Reserved for future use.

int64 pitr_timestamp_ms = 2;

Returns
Type	Description
long	The pitrTimestampMs.

getPointInTime()

public abstract Timestamp getPointInTime()

Timestamp, if specified, identifies the time to which the source instance is cloned.

.google.protobuf.Timestamp point_in_time = 5;

Returns
Type	Description
Timestamp	The pointInTime.

getPointInTimeOrBuilder()

public abstract TimestampOrBuilder getPointInTimeOrBuilder()

Timestamp, if specified, identifies the time to which the source instance is cloned.

.google.protobuf.Timestamp point_in_time = 5;

Returns
Type	Description
TimestampOrBuilder

getPreferredSecondaryZone()

public abstract String getPreferredSecondaryZone()

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.

optional string preferred_secondary_zone = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The preferredSecondaryZone.

getPreferredSecondaryZoneBytes()

public abstract ByteString getPreferredSecondaryZoneBytes()

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.

optional string preferred_secondary_zone = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for preferredSecondaryZone.

getPreferredZone()

public abstract String getPreferredZone()

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.

optional string preferred_zone = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The preferredZone.

getPreferredZoneBytes()

public abstract ByteString getPreferredZoneBytes()

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.

optional string preferred_zone = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for preferredZone.

getSourceInstanceDeletionTime()

public abstract Timestamp getSourceInstanceDeletionTime()

The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.

optional .google.protobuf.Timestamp source_instance_deletion_time = 12;

Returns
Type	Description
Timestamp	The sourceInstanceDeletionTime.

getSourceInstanceDeletionTimeOrBuilder()

public abstract TimestampOrBuilder getSourceInstanceDeletionTimeOrBuilder()

The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.

optional .google.protobuf.Timestamp source_instance_deletion_time = 12;

Returns
Type	Description
TimestampOrBuilder

hasBinLogCoordinates()

public abstract boolean hasBinLogCoordinates()

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.

.google.cloud.sql.v1.BinLogCoordinates bin_log_coordinates = 4;

Returns
Type	Description
boolean	Whether the binLogCoordinates field is set.

hasDestinationNetwork()

public abstract boolean hasDestinationNetwork()

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.

optional string destination_network = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the destinationNetwork field is set.

hasDestinationProject()

public abstract boolean hasDestinationProject()

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.

optional string destination_project = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the destinationProject field is set.

hasPointInTime()

public abstract boolean hasPointInTime()

Timestamp, if specified, identifies the time to which the source instance is cloned.

.google.protobuf.Timestamp point_in_time = 5;

Returns
Type	Description
boolean	Whether the pointInTime field is set.

hasPreferredSecondaryZone()

public abstract boolean hasPreferredSecondaryZone()

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.

optional string preferred_secondary_zone = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the preferredSecondaryZone field is set.

hasPreferredZone()

public abstract boolean hasPreferredZone()

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.

optional string preferred_zone = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the preferredZone field is set.

hasSourceInstanceDeletionTime()

public abstract boolean hasSourceInstanceDeletionTime()

The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp.

optional .google.protobuf.Timestamp source_instance_deletion_time = 12;

Returns
Type	Description
boolean	Whether the sourceInstanceDeletionTime field is set.