Reference documentation and code samples for the Google Cloud Dms V1 Client class GenerateTcpProxyScriptRequest.
Request message for 'GenerateTcpProxyScript' request.
Generated from protobuf messagegoogle.cloud.clouddms.v1.GenerateTcpProxyScriptRequest
Namespace
Google \ Cloud \ CloudDms \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ migration_job
string
Name of the migration job resource to generate the TCP Proxy script.
↳ vm_name
string
Required. The name of the Compute instance that will host the proxy.
↳ vm_machine_type
string
Required. The type of the Compute instance that will host the proxy.
↳ vm_zone
string
Optional. The Google Cloud Platform zone to create the VM in. The fully qualified name of the zone must be specified, including the region name, for example "us-central1-b". If not specified, uses the "-b" zone of the destination Connection Profile's region.
↳ vm_subnet
string
Required. The name of the subnet the Compute instance will use for private connectivity. Must be supplied in the form of projects/{project}/regions/{region}/subnetworks/{subnetwork}. Note: the region for the subnet must match the Compute instance region.
getMigrationJob
Name of the migration job resource to generate the TCP Proxy script.
Returns
Type
Description
string
setMigrationJob
Name of the migration job resource to generate the TCP Proxy script.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getVmName
Required. The name of the Compute instance that will host the proxy.
Returns
Type
Description
string
setVmName
Required. The name of the Compute instance that will host the proxy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getVmMachineType
Required. The type of the Compute instance that will host the proxy.
Returns
Type
Description
string
setVmMachineType
Required. The type of the Compute instance that will host the proxy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getVmZone
Optional. The Google Cloud Platform zone to create the VM in. The fully
qualified name of the zone must be specified, including the region name,
for example "us-central1-b". If not specified, uses the "-b" zone of the
destination Connection Profile's region.
Returns
Type
Description
string
setVmZone
Optional. The Google Cloud Platform zone to create the VM in. The fully
qualified name of the zone must be specified, including the region name,
for example "us-central1-b". If not specified, uses the "-b" zone of the
destination Connection Profile's region.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getVmSubnet
Required. The name of the subnet the Compute instance will use for private
connectivity. Must be supplied in the form of
projects/{project}/regions/{region}/subnetworks/{subnetwork}.
Note: the region for the subnet must match the Compute instance region.
Returns
Type
Description
string
setVmSubnet
Required. The name of the subnet the Compute instance will use for private
connectivity. Must be supplied in the form of
projects/{project}/regions/{region}/subnetworks/{subnetwork}.
Note: the region for the subnet must match the Compute instance region.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dms V1 Client - Class GenerateTcpProxyScriptRequest (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-dms/latest/V1.GenerateTcpProxyScriptRequest)\n- [2.0.5](/php/docs/reference/cloud-dms/2.0.5/V1.GenerateTcpProxyScriptRequest)\n- [1.5.5](/php/docs/reference/cloud-dms/1.5.5/V1.GenerateTcpProxyScriptRequest)\n- [1.4.2](/php/docs/reference/cloud-dms/1.4.2/V1.GenerateTcpProxyScriptRequest)\n- [1.3.0](/php/docs/reference/cloud-dms/1.3.0/V1.GenerateTcpProxyScriptRequest)\n- [1.2.1](/php/docs/reference/cloud-dms/1.2.1/V1.GenerateTcpProxyScriptRequest)\n- [1.1.0](/php/docs/reference/cloud-dms/1.1.0/V1.GenerateTcpProxyScriptRequest)\n- [1.0.5](/php/docs/reference/cloud-dms/1.0.5/V1.GenerateTcpProxyScriptRequest) \nReference documentation and code samples for the Google Cloud Dms V1 Client class GenerateTcpProxyScriptRequest.\n\nRequest message for 'GenerateTcpProxyScript' request.\n\nGenerated from protobuf message `google.cloud.clouddms.v1.GenerateTcpProxyScriptRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ CloudDms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMigrationJob\n\nName of the migration job resource to generate the TCP Proxy script.\n\n### setMigrationJob\n\nName of the migration job resource to generate the TCP Proxy script.\n\n### getVmName\n\nRequired. The name of the Compute instance that will host the proxy.\n\n### setVmName\n\nRequired. The name of the Compute instance that will host the proxy.\n\n### getVmMachineType\n\nRequired. The type of the Compute instance that will host the proxy.\n\n### setVmMachineType\n\nRequired. The type of the Compute instance that will host the proxy.\n\n### getVmZone\n\nOptional. The Google Cloud Platform zone to create the VM in. The fully\nqualified name of the zone must be specified, including the region name,\nfor example \"us-central1-b\". If not specified, uses the \"-b\" zone of the\ndestination Connection Profile's region.\n\n### setVmZone\n\nOptional. The Google Cloud Platform zone to create the VM in. The fully\nqualified name of the zone must be specified, including the region name,\nfor example \"us-central1-b\". If not specified, uses the \"-b\" zone of the\ndestination Connection Profile's region.\n\n### getVmSubnet\n\nRequired. The name of the subnet the Compute instance will use for private\nconnectivity. Must be supplied in the form of\nprojects/{project}/regions/{region}/subnetworks/{subnetwork}.\n\nNote: the region for the subnet must match the Compute instance region.\n\n### setVmSubnet\n\nRequired. The name of the subnet the Compute instance will use for private\nconnectivity. Must be supplied in the form of\nprojects/{project}/regions/{region}/subnetworks/{subnetwork}.\n\nNote: the region for the subnet must match the Compute instance region."]]