Class CloneContext (0.1.0)

public final class CloneContext extends GeneratedMessage implements CloneContextOrBuilder

Database instance clone context.

Protobuf type google.cloud.sql.v1beta4.CloneContext

Static Fields

ALLOCATED_IP_RANGE_FIELD_NUMBER

public static final int ALLOCATED_IP_RANGE_FIELD_NUMBER
Field Value
Type Description
int

BIN_LOG_COORDINATES_FIELD_NUMBER

public static final int BIN_LOG_COORDINATES_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_NAMES_FIELD_NUMBER

public static final int DATABASE_NAMES_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_INSTANCE_NAME_FIELD_NUMBER

public static final int DESTINATION_INSTANCE_NAME_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_NETWORK_FIELD_NUMBER

public static final int DESTINATION_NETWORK_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_PROJECT_FIELD_NUMBER

public static final int DESTINATION_PROJECT_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

PITR_TIMESTAMP_MS_FIELD_NUMBER

public static final int PITR_TIMESTAMP_MS_FIELD_NUMBER
Field Value
Type Description
int

POINT_IN_TIME_FIELD_NUMBER

public static final int POINT_IN_TIME_FIELD_NUMBER
Field Value
Type Description
int

PREFERRED_SECONDARY_ZONE_FIELD_NUMBER

public static final int PREFERRED_SECONDARY_ZONE_FIELD_NUMBER
Field Value
Type Description
int

PREFERRED_ZONE_FIELD_NUMBER

public static final int PREFERRED_ZONE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_INSTANCE_DELETION_TIME_FIELD_NUMBER

public static final int SOURCE_INSTANCE_DELETION_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CloneContext getDefaultInstance()
Returns
Type Description
CloneContext

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CloneContext.Builder newBuilder()
Returns
Type Description
CloneContext.Builder

newBuilder(CloneContext prototype)

public static CloneContext.Builder newBuilder(CloneContext prototype)
Parameter
Name Description
prototype CloneContext
Returns
Type Description
CloneContext.Builder

parseDelimitedFrom(InputStream input)

public static CloneContext parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CloneContext
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloneContext parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloneContext
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CloneContext parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CloneContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CloneContext parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloneContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CloneContext parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CloneContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CloneContext parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloneContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CloneContext parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CloneContext
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CloneContext parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloneContext
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CloneContext parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CloneContext
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CloneContext parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloneContext
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CloneContext parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CloneContext
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CloneContext parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CloneContext
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CloneContext> parser()
Returns
Type Description
Parser<CloneContext>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllocatedIpRange()

public 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 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 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.v1beta4.BinLogCoordinates bin_log_coordinates = 4;

Returns
Type Description
BinLogCoordinates

The binLogCoordinates.

getBinLogCoordinatesOrBuilder()

public 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.v1beta4.BinLogCoordinates bin_log_coordinates = 4;

Returns
Type Description
BinLogCoordinatesOrBuilder

getDatabaseNames(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the databaseNames.

getDefaultInstanceForType()

public CloneContext getDefaultInstanceForType()
Returns
Type Description
CloneContext

getDestinationInstanceName()

public String getDestinationInstanceName()

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

string destination_instance_name = 3;

Returns
Type Description
String

The destinationInstanceName.

getDestinationInstanceNameBytes()

public ByteString getDestinationInstanceNameBytes()

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

string destination_instance_name = 3;

Returns
Type Description
ByteString

The bytes for destinationInstanceName.

getDestinationNetwork()

public 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 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 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 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 String getKind()

This is always sql#cloneContext.

string kind = 1;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#cloneContext.

string kind = 1;

Returns
Type Description
ByteString

The bytes for kind.

getParserForType()

public Parser<CloneContext> getParserForType()
Returns
Type Description
Parser<CloneContext>
Overrides

getPitrTimestampMs()

public long getPitrTimestampMs()

Reserved for future use.

int64 pitr_timestamp_ms = 2;

Returns
Type Description
long

The pitrTimestampMs.

getPointInTime()

public 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 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 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.

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

Returns
Type Description
String

The preferredSecondaryZone.

getPreferredSecondaryZoneBytes()

public 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.

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

Returns
Type Description
ByteString

The bytes for preferredSecondaryZone.

getPreferredZone()

public 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.

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

Returns
Type Description
String

The preferredZone.

getPreferredZoneBytes()

public 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.

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

Returns
Type Description
ByteString

The bytes for preferredZone.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceInstanceDeletionTime()

public 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 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 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.v1beta4.BinLogCoordinates bin_log_coordinates = 4;

Returns
Type Description
boolean

Whether the binLogCoordinates field is set.

hasDestinationNetwork()

public 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 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 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 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.

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

Returns
Type Description
boolean

Whether the preferredSecondaryZone field is set.

hasPreferredZone()

public 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.

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

Returns
Type Description
boolean

Whether the preferredZone field is set.

hasSourceInstanceDeletionTime()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CloneContext.Builder newBuilderForType()
Returns
Type Description
CloneContext.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CloneContext.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CloneContext.Builder
Overrides

toBuilder()

public CloneContext.Builder toBuilder()
Returns
Type Description
CloneContext.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException