Class ReverseSshConnectivity.Builder (2.45.0)

public static final class ReverseSshConnectivity.Builder extends GeneratedMessageV3.Builder<ReverseSshConnectivity.Builder> implements ReverseSshConnectivityOrBuilder

The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.

Protobuf type google.cloud.clouddms.v1.ReverseSshConnectivity

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReverseSshConnectivity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

build()

public ReverseSshConnectivity build()
Returns
Type Description
ReverseSshConnectivity

buildPartial()

public ReverseSshConnectivity buildPartial()
Returns
Type Description
ReverseSshConnectivity

clear()

public ReverseSshConnectivity.Builder clear()
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ReverseSshConnectivity.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ReverseSshConnectivity.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

clearVm()

public ReverseSshConnectivity.Builder clearVm()

The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm = 3;

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

clearVmIp()

public ReverseSshConnectivity.Builder clearVmIp()

Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm_ip = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

clearVmPort()

public ReverseSshConnectivity.Builder clearVmPort()

Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

int32 vm_port = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

clearVpc()

public ReverseSshConnectivity.Builder clearVpc()

The name of the VPC to peer with the Cloud SQL private network.

string vpc = 4;

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

clone()

public ReverseSshConnectivity.Builder clone()
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

getDefaultInstanceForType()

public ReverseSshConnectivity getDefaultInstanceForType()
Returns
Type Description
ReverseSshConnectivity

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getVm()

public String getVm()

The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm = 3;

Returns
Type Description
String

The vm.

getVmBytes()

public ByteString getVmBytes()

The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm = 3;

Returns
Type Description
ByteString

The bytes for vm.

getVmIp()

public String getVmIp()

Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm_ip = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The vmIp.

getVmIpBytes()

public ByteString getVmIpBytes()

Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm_ip = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for vmIp.

getVmPort()

public int getVmPort()

Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

int32 vm_port = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The vmPort.

getVpc()

public String getVpc()

The name of the VPC to peer with the Cloud SQL private network.

string vpc = 4;

Returns
Type Description
String

The vpc.

getVpcBytes()

public ByteString getVpcBytes()

The name of the VPC to peer with the Cloud SQL private network.

string vpc = 4;

Returns
Type Description
ByteString

The bytes for vpc.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ReverseSshConnectivity other)

public ReverseSshConnectivity.Builder mergeFrom(ReverseSshConnectivity other)
Parameter
Name Description
other ReverseSshConnectivity
Returns
Type Description
ReverseSshConnectivity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReverseSshConnectivity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ReverseSshConnectivity.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReverseSshConnectivity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ReverseSshConnectivity.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReverseSshConnectivity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ReverseSshConnectivity.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReverseSshConnectivity.Builder
Overrides

setVm(String value)

public ReverseSshConnectivity.Builder setVm(String value)

The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm = 3;

Parameter
Name Description
value String

The vm to set.

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

setVmBytes(ByteString value)

public ReverseSshConnectivity.Builder setVmBytes(ByteString value)

The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm = 3;

Parameter
Name Description
value ByteString

The bytes for vm to set.

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

setVmIp(String value)

public ReverseSshConnectivity.Builder setVmIp(String value)

Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm_ip = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The vmIp to set.

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

setVmIpBytes(ByteString value)

public ReverseSshConnectivity.Builder setVmIpBytes(ByteString value)

Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

string vm_ip = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for vmIp to set.

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

setVmPort(int value)

public ReverseSshConnectivity.Builder setVmPort(int value)

Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.

int32 vm_port = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The vmPort to set.

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

setVpc(String value)

public ReverseSshConnectivity.Builder setVpc(String value)

The name of the VPC to peer with the Cloud SQL private network.

string vpc = 4;

Parameter
Name Description
value String

The vpc to set.

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.

setVpcBytes(ByteString value)

public ReverseSshConnectivity.Builder setVpcBytes(ByteString value)

The name of the VPC to peer with the Cloud SQL private network.

string vpc = 4;

Parameter
Name Description
value ByteString

The bytes for vpc to set.

Returns
Type Description
ReverseSshConnectivity.Builder

This builder for chaining.