VMwareEngine manages VMware's private clusters in the Cloud. v1
Package
@google-cloud/vmwareengine
Constructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of VmwareEngineClient.
Parameters |
---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of google-gax . Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new VmwareEngineClient({fallback: true}, gax); ```
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
descriptors
descriptors: Descriptors;
iamClient
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
vmwareEngineStub
vmwareEngineStub?: Promise<{
[name: string]: Function;
}>;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Example
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkCreateClusterProgress(name)
checkCreateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.Cluster, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createCluster()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud to create a new cluster
* in. Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the new `Cluster`.
* This identifier must be unique among clusters within the parent and becomes
* the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const clusterId = 'abc123'
/**
* Required. The initial description of the new cluster.
*/
// const cluster = {}
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. True if you want the request to be validated and not executed;
* false otherwise.
*/
// const validateOnly = true
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateCluster() {
// Construct request
const request = {
parent,
clusterId,
cluster,
};
// Run request
const [operation] = await vmwareengineClient.createCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCluster();
checkCreateExternalAccessRuleProgress(name)
checkCreateExternalAccessRuleProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.ExternalAccessRule, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createExternalAccessRule()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network policy
* to create a new external access firewall rule in.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/networkPolicies/my-policy`
*/
// const parent = 'abc123'
/**
* Required. The initial description of a new external access rule.
*/
// const externalAccessRule = {}
/**
* Required. The user-provided identifier of the `ExternalAccessRule` to be
* created. This identifier must be unique among `ExternalAccessRule`
* resources within the parent and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const externalAccessRuleId = 'abc123'
/**
* A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateExternalAccessRule() {
// Construct request
const request = {
parent,
externalAccessRule,
externalAccessRuleId,
};
// Run request
const [operation] = await vmwareengineClient.createExternalAccessRule(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateExternalAccessRule();
checkCreateExternalAddressProgress(name)
checkCreateExternalAddressProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.ExternalAddress, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createExternalAddress()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud
* to create a new external IP address in.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The initial description of a new external IP address.
*/
// const externalAddress = {}
/**
* Required. The user-provided identifier of the `ExternalAddress` to be
* created. This identifier must be unique among `ExternalAddress` resources
* within the parent and becomes the final token in the name URI. The
* identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const externalAddressId = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateExternalAddress() {
// Construct request
const request = {
parent,
externalAddress,
externalAddressId,
};
// Run request
const [operation] = await vmwareengineClient.createExternalAddress(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateExternalAddress();
checkCreateHcxActivationKeyProgress(name)
checkCreateHcxActivationKeyProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.HcxActivationKey, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createHcxActivationKey()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud to create the key for.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The initial description of a new HCX activation key. When
* creating a new key, this field must be an empty object.
*/
// const hcxActivationKey = {}
/**
* Required. The user-provided identifier of the `HcxActivationKey` to be
* created. This identifier must be unique among `HcxActivationKey` resources
* within the parent and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const hcxActivationKeyId = 'abc123'
/**
* A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateHcxActivationKey() {
// Construct request
const request = {
parent,
hcxActivationKey,
hcxActivationKeyId,
};
// Run request
const [operation] = await vmwareengineClient.createHcxActivationKey(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateHcxActivationKey();
checkCreateLoggingServerProgress(name)
checkCreateLoggingServerProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.LoggingServer, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createLoggingServer()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud
* to create a new Logging Server in.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The initial description of a new logging server.
*/
// const loggingServer = {}
/**
* Required. The user-provided identifier of the `LoggingServer` to be
* created. This identifier must be unique among `LoggingServer` resources
* within the parent and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const loggingServerId = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateLoggingServer() {
// Construct request
const request = {
parent,
loggingServer,
loggingServerId,
};
// Run request
const [operation] = await vmwareengineClient.createLoggingServer(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateLoggingServer();
checkCreateManagementDnsZoneBindingProgress(name)
checkCreateManagementDnsZoneBindingProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.ManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createManagementDnsZoneBinding()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud
* to create a new management DNS zone binding for.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The initial values for a new management DNS zone binding.
*/
// const managementDnsZoneBinding = {}
/**
* Required. The user-provided identifier of the `ManagementDnsZoneBinding`
* resource to be created. This identifier must be unique among
* `ManagementDnsZoneBinding` resources within the parent and becomes the
* final token in the name URI. The identifier must meet the following
* requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const managementDnsZoneBindingId = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateManagementDnsZoneBinding() {
// Construct request
const request = {
parent,
managementDnsZoneBinding,
managementDnsZoneBindingId,
};
// Run request
const [operation] = await vmwareengineClient.createManagementDnsZoneBinding(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateManagementDnsZoneBinding();
checkCreateNetworkPeeringProgress(name)
checkCreateNetworkPeeringProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPeering, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createNetworkPeering()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location to create the new network
* peering in. This value is always `global`, because `NetworkPeering` is a
* global resource. Resource names are schemeless URIs that follow the
* conventions in https://cloud.google.com/apis/design/resource_names. For
* example: `projects/my-project/locations/global`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the new `NetworkPeering`.
* This identifier must be unique among `NetworkPeering` resources within the
* parent and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const networkPeeringId = 'abc123'
/**
* Required. The initial description of the new network peering.
*/
// const networkPeering = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateNetworkPeering() {
// Construct request
const request = {
parent,
networkPeeringId,
networkPeering,
};
// Run request
const [operation] = await vmwareengineClient.createNetworkPeering(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateNetworkPeering();
checkCreateNetworkPolicyProgress(name)
checkCreateNetworkPolicyProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPolicy, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createNetworkPolicy()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location (region)
* to create the new network policy in.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the network policy to be created.
* This identifier must be unique within parent
* `projects/{my-project}/locations/{us-central1}/networkPolicies` and becomes
* the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const networkPolicyId = 'abc123'
/**
* Required. The network policy configuration to use in the request.
*/
// const networkPolicy = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateNetworkPolicy() {
// Construct request
const request = {
parent,
networkPolicyId,
networkPolicy,
};
// Run request
const [operation] = await vmwareengineClient.createNetworkPolicy(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateNetworkPolicy();
checkCreatePrivateCloudProgress(name)
checkCreatePrivateCloudProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createPrivateCloud()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location to create the new
* private cloud in. Resource names are schemeless URIs that follow the
* conventions in https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the private cloud to be created.
* This identifier must be unique among each `PrivateCloud` within the parent
* and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const privateCloudId = 'abc123'
/**
* Required. The initial description of the new private cloud.
*/
// const privateCloud = {}
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. True if you want the request to be validated and not executed;
* false otherwise.
*/
// const validateOnly = true
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreatePrivateCloud() {
// Construct request
const request = {
parent,
privateCloudId,
privateCloud,
};
// Run request
const [operation] = await vmwareengineClient.createPrivateCloud(request);
const [response] = await operation.promise();
console.log(response);
}
callCreatePrivateCloud();
checkCreatePrivateConnectionProgress(name)
checkCreatePrivateConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateConnection, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createPrivateConnection()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location to create the new private
* connection in. Private connection is a regional resource.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/us-central1`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the new private connection.
* This identifier must be unique among private connection resources
* within the parent and becomes the final token in the name URI. The
* identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const privateConnectionId = 'abc123'
/**
* Required. The initial description of the new private connection.
*/
// const privateConnection = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreatePrivateConnection() {
// Construct request
const request = {
parent,
privateConnectionId,
privateConnection,
};
// Run request
const [operation] = await vmwareengineClient.createPrivateConnection(request);
const [response] = await operation.promise();
console.log(response);
}
callCreatePrivateConnection();
checkCreateVmwareEngineNetworkProgress(name)
checkCreateVmwareEngineNetworkProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.VmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by createVmwareEngineNetwork()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location to create the new VMware Engine
* network in. A VMware Engine network of type
* `LEGACY` is a regional resource, and a VMware
* Engine network of type `STANDARD` is a global resource.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the new VMware Engine network.
* This identifier must be unique among VMware Engine network resources
* within the parent and becomes the final token in the name URI. The
* identifier must meet the following requirements:
* * For networks of type LEGACY, adheres to the format:
* `{region-id}-default`. Replace `{region-id}` with the region where you want
* to create the VMware Engine network. For example, "us-central1-default".
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const vmwareEngineNetworkId = 'abc123'
/**
* Required. The initial description of the new VMware Engine network.
*/
// const vmwareEngineNetwork = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateVmwareEngineNetwork() {
// Construct request
const request = {
parent,
vmwareEngineNetworkId,
vmwareEngineNetwork,
};
// Run request
const [operation] = await vmwareengineClient.createVmwareEngineNetwork(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateVmwareEngineNetwork();
checkDeleteClusterProgress(name)
checkDeleteClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteCluster()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the cluster to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
*/
// const name = 'abc123'
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteCluster() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCluster();
checkDeleteExternalAccessRuleProgress(name)
checkDeleteExternalAccessRuleProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteExternalAccessRule()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the external access firewall rule to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if the original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteExternalAccessRule() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteExternalAccessRule(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteExternalAccessRule();
checkDeleteExternalAddressProgress(name)
checkDeleteExternalAddressProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteExternalAddress()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the external IP address to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-ip`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if the original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteExternalAddress() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteExternalAddress(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteExternalAddress();
checkDeleteLoggingServerProgress(name)
checkDeleteLoggingServerProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteLoggingServer()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the logging server to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/loggingServers/my-logging-server`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteLoggingServer() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteLoggingServer(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteLoggingServer();
checkDeleteManagementDnsZoneBindingProgress(name)
checkDeleteManagementDnsZoneBindingProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteManagementDnsZoneBinding()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the management DNS zone binding to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if the original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteManagementDnsZoneBinding() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteManagementDnsZoneBinding(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteManagementDnsZoneBinding();
checkDeleteNetworkPeeringProgress(name)
checkDeleteNetworkPeeringProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteNetworkPeering()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network peering to be deleted.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/global/networkPeerings/my-peering`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteNetworkPeering() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteNetworkPeering(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteNetworkPeering();
checkDeleteNetworkPolicyProgress(name)
checkDeleteNetworkPolicyProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteNetworkPolicy()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network policy to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteNetworkPolicy() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteNetworkPolicy(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteNetworkPolicy();
checkDeletePrivateCloudProgress(name)
checkDeletePrivateCloudProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deletePrivateCloud()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const name = 'abc123'
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. If set to true, cascade delete is enabled and all children of
* this private cloud resource are also deleted. When this flag is set to
* false, the private cloud will not be deleted if there are any children
* other than the management cluster. The management cluster is always
* deleted.
*/
// const force = true
/**
* Optional. Time delay of the deletion specified in hours. The default value
* is `3`. Specifying a non-zero value for this field changes the value of
* `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned
* deletion time. Deletion can be cancelled before `expire_time` elapses using
* VmwareEngine.UndeletePrivateCloud google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud.
* Specifying a value of `0` for this field instead begins the deletion
* process and ceases billing immediately. During the final deletion process,
* the value of `PrivateCloud.state` becomes `PURGING`.
*/
// const delayHours = 1234
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeletePrivateCloud() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deletePrivateCloud(request);
const [response] = await operation.promise();
console.log(response);
}
callDeletePrivateCloud();
checkDeletePrivateConnectionProgress(name)
checkDeletePrivateConnectionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deletePrivateConnection()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private connection to be deleted.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/privateConnections/my-connection`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeletePrivateConnection() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deletePrivateConnection(request);
const [response] = await operation.promise();
console.log(response);
}
callDeletePrivateConnection();
checkDeleteVmwareEngineNetworkProgress(name)
checkDeleteVmwareEngineNetworkProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteVmwareEngineNetwork()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the VMware Engine network to be deleted.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/global/vmwareEngineNetworks/my-network`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. Checksum used to ensure that the user-provided value is up to
* date before the server processes the request. The server compares provided
* checksum with the current checksum of the resource. If the user-provided
* value is out of date, this request returns an `ABORTED` error.
*/
// const etag = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteVmwareEngineNetwork() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteVmwareEngineNetwork(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteVmwareEngineNetwork();
checkGrantDnsBindPermissionProgress(name)
checkGrantDnsBindPermissionProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.DnsBindPermission, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by grantDnsBindPermission()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource which stores the users/service accounts
* having the permission to bind to the corresponding intranet VPC of the
* consumer project. DnsBindPermission is a global resource. Resource names
* are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global/dnsBindPermission`
*/
// const name = 'abc123'
/**
* Required. The consumer provided user/service account which needs to be
* granted permission to bind with the intranet VPC corresponding to the
* consumer project.
*/
// const principal = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGrantDnsBindPermission() {
// Construct request
const request = {
name,
principal,
};
// Run request
const [operation] = await vmwareengineClient.grantDnsBindPermission(request);
const [response] = await operation.promise();
console.log(response);
}
callGrantDnsBindPermission();
checkRepairManagementDnsZoneBindingProgress(name)
checkRepairManagementDnsZoneBindingProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.ManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by repairManagementDnsZoneBinding()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the management DNS zone binding to repair.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callRepairManagementDnsZoneBinding() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.repairManagementDnsZoneBinding(request);
const [response] = await operation.promise();
console.log(response);
}
callRepairManagementDnsZoneBinding();
checkResetNsxCredentialsProgress(name)
checkResetNsxCredentialsProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by resetNsxCredentials()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud
* to reset credentials for.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const privateCloud = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callResetNsxCredentials() {
// Construct request
const request = {
privateCloud,
};
// Run request
const [operation] = await vmwareengineClient.resetNsxCredentials(request);
const [response] = await operation.promise();
console.log(response);
}
callResetNsxCredentials();
checkResetVcenterCredentialsProgress(name)
checkResetVcenterCredentialsProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by resetVcenterCredentials()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud
* to reset credentials for.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const privateCloud = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. The username of the user to be to reset the credentials.
* The default value of this field is CloudOwner@gve.local.
* The provided value should be one of the following:
* solution-user-01@gve.local,
* solution-user-02@gve.local,
* solution-user-03@gve.local,
* solution-user-04@gve.local,
* solution-user-05@gve.local,
* zertoadmin@gve.local.
*/
// const username = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callResetVcenterCredentials() {
// Construct request
const request = {
privateCloud,
};
// Run request
const [operation] = await vmwareengineClient.resetVcenterCredentials(request);
const [response] = await operation.promise();
console.log(response);
}
callResetVcenterCredentials();
checkRevokeDnsBindPermissionProgress(name)
checkRevokeDnsBindPermissionProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.DnsBindPermission, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by revokeDnsBindPermission()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource which stores the users/service accounts
* having the permission to bind to the corresponding intranet VPC of the
* consumer project. DnsBindPermission is a global resource. Resource names
* are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global/dnsBindPermission`
*/
// const name = 'abc123'
/**
* Required. The consumer provided user/service account which needs to be
* granted permission to bind with the intranet VPC corresponding to the
* consumer project.
*/
// const principal = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callRevokeDnsBindPermission() {
// Construct request
const request = {
name,
principal,
};
// Run request
const [operation] = await vmwareengineClient.revokeDnsBindPermission(request);
const [response] = await operation.promise();
console.log(response);
}
callRevokeDnsBindPermission();
checkUndeletePrivateCloudProgress(name)
checkUndeletePrivateCloudProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by undeletePrivateCloud()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud scheduled for deletion.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const name = 'abc123'
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUndeletePrivateCloud() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.undeletePrivateCloud(request);
const [response] = await operation.promise();
console.log(response);
}
callUndeletePrivateCloud();
checkUpdateClusterProgress(name)
checkUpdateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.Cluster, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateCluster()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `Cluster` resource by the update. The fields specified in the `updateMask`
* are relative to the resource, not the full request. A field will be
* overwritten if it is in the mask. If the user does not provide a mask then
* all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. The description of the cluster.
*/
// const cluster = {}
/**
* Optional. The request ID must be a valid UUID with the exception that
* zero UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. True if you want the request to be validated and not executed;
* false otherwise.
*/
// const validateOnly = true
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateCluster() {
// Construct request
const request = {
updateMask,
cluster,
};
// Run request
const [operation] = await vmwareengineClient.updateCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateCluster();
checkUpdateDnsForwardingProgress(name)
checkUpdateDnsForwardingProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.DnsForwarding, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateDnsForwarding()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. DnsForwarding config details.
*/
// const dnsForwarding = {}
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `DnsForwarding` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateDnsForwarding() {
// Construct request
const request = {
dnsForwarding,
updateMask,
};
// Run request
const [operation] = await vmwareengineClient.updateDnsForwarding(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateDnsForwarding();
checkUpdateExternalAccessRuleProgress(name)
checkUpdateExternalAccessRuleProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.ExternalAccessRule, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateExternalAccessRule()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `ExternalAccessRule` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. Description of the external access rule.
*/
// const externalAccessRule = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateExternalAccessRule() {
// Construct request
const request = {
updateMask,
externalAccessRule,
};
// Run request
const [operation] = await vmwareengineClient.updateExternalAccessRule(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateExternalAccessRule();
checkUpdateExternalAddressProgress(name)
checkUpdateExternalAddressProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.ExternalAddress, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateExternalAddress()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `ExternalAddress` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. External IP address description.
*/
// const externalAddress = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateExternalAddress() {
// Construct request
const request = {
updateMask,
externalAddress,
};
// Run request
const [operation] = await vmwareengineClient.updateExternalAddress(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateExternalAddress();
checkUpdateLoggingServerProgress(name)
checkUpdateLoggingServerProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.LoggingServer, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateLoggingServer()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `LoggingServer` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. Logging server description.
*/
// const loggingServer = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateLoggingServer() {
// Construct request
const request = {
updateMask,
loggingServer,
};
// Run request
const [operation] = await vmwareengineClient.updateLoggingServer(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateLoggingServer();
checkUpdateManagementDnsZoneBindingProgress(name)
checkUpdateManagementDnsZoneBindingProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.ManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateManagementDnsZoneBinding()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `ManagementDnsZoneBinding` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. New values to update the management DNS zone binding with.
*/
// const managementDnsZoneBinding = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateManagementDnsZoneBinding() {
// Construct request
const request = {
updateMask,
managementDnsZoneBinding,
};
// Run request
const [operation] = await vmwareengineClient.updateManagementDnsZoneBinding(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateManagementDnsZoneBinding();
checkUpdateNetworkPeeringProgress(name)
checkUpdateNetworkPeeringProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPeering, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateNetworkPeering()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Network peering description.
*/
// const networkPeering = {}
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `NetworkPeering` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateNetworkPeering() {
// Construct request
const request = {
networkPeering,
updateMask,
};
// Run request
const [operation] = await vmwareengineClient.updateNetworkPeering(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateNetworkPeering();
checkUpdateNetworkPolicyProgress(name)
checkUpdateNetworkPolicyProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPolicy, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateNetworkPolicy()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Network policy description.
*/
// const networkPolicy = {}
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `NetworkPolicy` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateNetworkPolicy() {
// Construct request
const request = {
networkPolicy,
updateMask,
};
// Run request
const [operation] = await vmwareengineClient.updateNetworkPolicy(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateNetworkPolicy();
checkUpdatePrivateCloudProgress(name)
checkUpdatePrivateCloudProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updatePrivateCloud()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Private cloud description.
*/
// const privateCloud = {}
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `PrivateCloud` resource by the update. The fields specified in `updateMask`
* are relative to the resource, not the full request. A field will be
* overwritten if it is in the mask. If the user does not provide a mask then
* all fields will be overwritten.
*/
// const updateMask = {}
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdatePrivateCloud() {
// Construct request
const request = {
privateCloud,
updateMask,
};
// Run request
const [operation] = await vmwareengineClient.updatePrivateCloud(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdatePrivateCloud();
checkUpdatePrivateConnectionProgress(name)
checkUpdatePrivateConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateConnection, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updatePrivateConnection()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Private connection description.
*/
// const privateConnection = {}
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `PrivateConnection` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdatePrivateConnection() {
// Construct request
const request = {
privateConnection,
updateMask,
};
// Run request
const [operation] = await vmwareengineClient.updatePrivateConnection(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdatePrivateConnection();
checkUpdateSubnetProgress(name)
checkUpdateSubnetProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.Subnet, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateSubnet()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* `Subnet` resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
*/
// const updateMask = {}
/**
* Required. Subnet description.
*/
// const subnet = {}
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateSubnet() {
// Construct request
const request = {
updateMask,
subnet,
};
// Run request
const [operation] = await vmwareengineClient.updateSubnet(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateSubnet();
checkUpdateVmwareEngineNetworkProgress(name)
checkUpdateVmwareEngineNetworkProgress(name: string): Promise<LROperation<protos.google.cloud.vmwareengine.v1.VmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateVmwareEngineNetwork()
.
Parameter |
---|
Name | Description |
name |
string
The operation name that will be passed.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. VMware Engine network description.
*/
// const vmwareEngineNetwork = {}
/**
* Required. Field mask is used to specify the fields to be overwritten in the
* VMware Engine network resource by the update.
* The fields specified in the `update_mask` are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten. Only the
* following fields can be updated: `description`.
*/
// const updateMask = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callUpdateVmwareEngineNetwork() {
// Construct request
const request = {
vmwareEngineNetwork,
updateMask,
};
// Run request
const [operation] = await vmwareengineClient.updateVmwareEngineNetwork(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateVmwareEngineNetwork();
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns |
---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed.
|
clusterPath(project, location, privateCloud, cluster)
clusterPath(project: string, location: string, privateCloud: string, cluster: string): string;
Return a fully-qualified cluster resource name string.
Parameters |
---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
cluster |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
createCluster(request, options)
createCluster(request?: protos.google.cloud.vmwareengine.v1.ICreateClusterRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
ICreateClusterRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud to create a new cluster
* in. Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the new `Cluster`.
* This identifier must be unique among clusters within the parent and becomes
* the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const clusterId = 'abc123'
/**
* Required. The initial description of the new cluster.
*/
// const cluster = {}
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. True if you want the request to be validated and not executed;
* false otherwise.
*/
// const validateOnly = true
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateCluster() {
// Construct request
const request = {
parent,
clusterId,
cluster,
};
// Run request
const [operation] = await vmwareengineClient.createCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCluster();
createCluster(request, options, callback)
createCluster(request: protos.google.cloud.vmwareengine.v1.ICreateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createCluster(request, callback)
createCluster(request: protos.google.cloud.vmwareengine.v1.ICreateClusterRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createExternalAccessRule(request, options)
createExternalAccessRule(request?: protos.google.cloud.vmwareengine.v1.ICreateExternalAccessRuleRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new external access rule in a given network policy.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network policy
* to create a new external access firewall rule in.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/networkPolicies/my-policy`
*/
// const parent = 'abc123'
/**
* Required. The initial description of a new external access rule.
*/
// const externalAccessRule = {}
/**
* Required. The user-provided identifier of the `ExternalAccessRule` to be
* created. This identifier must be unique among `ExternalAccessRule`
* resources within the parent and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const externalAccessRuleId = 'abc123'
/**
* A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateExternalAccessRule() {
// Construct request
const request = {
parent,
externalAccessRule,
externalAccessRuleId,
};
// Run request
const [operation] = await vmwareengineClient.createExternalAccessRule(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateExternalAccessRule();
createExternalAccessRule(request, options, callback)
createExternalAccessRule(request: protos.google.cloud.vmwareengine.v1.ICreateExternalAccessRuleRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createExternalAccessRule(request, callback)
createExternalAccessRule(request: protos.google.cloud.vmwareengine.v1.ICreateExternalAccessRuleRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createExternalAddress(request, options)
createExternalAddress(request?: protos.google.cloud.vmwareengine.v1.ICreateExternalAddressRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new ExternalAddress
resource in a given private cloud. The network policy that corresponds to the private cloud must have the external IP address network service enabled (NetworkPolicy.external_ip
).
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud
* to create a new external IP address in.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The initial description of a new external IP address.
*/
// const externalAddress = {}
/**
* Required. The user-provided identifier of the `ExternalAddress` to be
* created. This identifier must be unique among `ExternalAddress` resources
* within the parent and becomes the final token in the name URI. The
* identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const externalAddressId = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateExternalAddress() {
// Construct request
const request = {
parent,
externalAddress,
externalAddressId,
};
// Run request
const [operation] = await vmwareengineClient.createExternalAddress(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateExternalAddress();
createExternalAddress(request, options, callback)
createExternalAddress(request: protos.google.cloud.vmwareengine.v1.ICreateExternalAddressRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createExternalAddress(request, callback)
createExternalAddress(request: protos.google.cloud.vmwareengine.v1.ICreateExternalAddressRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createHcxActivationKey(request, options)
createHcxActivationKey(request?: protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new HCX activation key in a given private cloud.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud to create the key for.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The initial description of a new HCX activation key. When
* creating a new key, this field must be an empty object.
*/
// const hcxActivationKey = {}
/**
* Required. The user-provided identifier of the `HcxActivationKey` to be
* created. This identifier must be unique among `HcxActivationKey` resources
* within the parent and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const hcxActivationKeyId = 'abc123'
/**
* A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateHcxActivationKey() {
// Construct request
const request = {
parent,
hcxActivationKey,
hcxActivationKeyId,
};
// Run request
const [operation] = await vmwareengineClient.createHcxActivationKey(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateHcxActivationKey();
createHcxActivationKey(request, options, callback)
createHcxActivationKey(request: protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createHcxActivationKey(request, callback)
createHcxActivationKey(request: protos.google.cloud.vmwareengine.v1.ICreateHcxActivationKeyRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createLoggingServer(request, options)
createLoggingServer(request?: protos.google.cloud.vmwareengine.v1.ICreateLoggingServerRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Create a new logging server for a given private cloud.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud
* to create a new Logging Server in.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The initial description of a new logging server.
*/
// const loggingServer = {}
/**
* Required. The user-provided identifier of the `LoggingServer` to be
* created. This identifier must be unique among `LoggingServer` resources
* within the parent and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const loggingServerId = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateLoggingServer() {
// Construct request
const request = {
parent,
loggingServer,
loggingServerId,
};
// Run request
const [operation] = await vmwareengineClient.createLoggingServer(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateLoggingServer();
createLoggingServer(request, options, callback)
createLoggingServer(request: protos.google.cloud.vmwareengine.v1.ICreateLoggingServerRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createLoggingServer(request, callback)
createLoggingServer(request: protos.google.cloud.vmwareengine.v1.ICreateLoggingServerRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createManagementDnsZoneBinding(request, options)
createManagementDnsZoneBinding(request?: protos.google.cloud.vmwareengine.v1.ICreateManagementDnsZoneBindingRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new ManagementDnsZoneBinding
resource in a private cloud. This RPC creates the DNS binding and the resource that represents the DNS binding of the consumer VPC network to the management DNS zone. A management DNS zone is the Cloud DNS cross-project binding zone that VMware Engine creates for each private cloud. It contains FQDNs and corresponding IP addresses for the private cloud's ESXi hosts and management VM appliances like vCenter and NSX Manager.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud
* to create a new management DNS zone binding for.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const parent = 'abc123'
/**
* Required. The initial values for a new management DNS zone binding.
*/
// const managementDnsZoneBinding = {}
/**
* Required. The user-provided identifier of the `ManagementDnsZoneBinding`
* resource to be created. This identifier must be unique among
* `ManagementDnsZoneBinding` resources within the parent and becomes the
* final token in the name URI. The identifier must meet the following
* requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const managementDnsZoneBindingId = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if the original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateManagementDnsZoneBinding() {
// Construct request
const request = {
parent,
managementDnsZoneBinding,
managementDnsZoneBindingId,
};
// Run request
const [operation] = await vmwareengineClient.createManagementDnsZoneBinding(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateManagementDnsZoneBinding();
createManagementDnsZoneBinding(request, options, callback)
createManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.ICreateManagementDnsZoneBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createManagementDnsZoneBinding(request, callback)
createManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.ICreateManagementDnsZoneBindingRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createNetworkPeering(request, options)
createNetworkPeering(request?: protos.google.cloud.vmwareengine.v1.ICreateNetworkPeeringRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering
resource. NetworkPeering is a global resource and location can only be global.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location to create the new network
* peering in. This value is always `global`, because `NetworkPeering` is a
* global resource. Resource names are schemeless URIs that follow the
* conventions in https://cloud.google.com/apis/design/resource_names. For
* example: `projects/my-project/locations/global`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the new `NetworkPeering`.
* This identifier must be unique among `NetworkPeering` resources within the
* parent and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const networkPeeringId = 'abc123'
/**
* Required. The initial description of the new network peering.
*/
// const networkPeering = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateNetworkPeering() {
// Construct request
const request = {
parent,
networkPeeringId,
networkPeering,
};
// Run request
const [operation] = await vmwareengineClient.createNetworkPeering(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateNetworkPeering();
createNetworkPeering(request, options, callback)
createNetworkPeering(request: protos.google.cloud.vmwareengine.v1.ICreateNetworkPeeringRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createNetworkPeering(request, callback)
createNetworkPeering(request: protos.google.cloud.vmwareengine.v1.ICreateNetworkPeeringRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createNetworkPolicy(request, options)
createNetworkPolicy(request?: protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new network policy in a given VMware Engine network of a project and location (region). A new network policy cannot be created if another network policy already exists in the same scope.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location (region)
* to create the new network policy in.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the network policy to be created.
* This identifier must be unique within parent
* `projects/{my-project}/locations/{us-central1}/networkPolicies` and becomes
* the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const networkPolicyId = 'abc123'
/**
* Required. The network policy configuration to use in the request.
*/
// const networkPolicy = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateNetworkPolicy() {
// Construct request
const request = {
parent,
networkPolicyId,
networkPolicy,
};
// Run request
const [operation] = await vmwareengineClient.createNetworkPolicy(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateNetworkPolicy();
createNetworkPolicy(request, options, callback)
createNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createNetworkPolicy(request, callback)
createNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.ICreateNetworkPolicyRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createPrivateCloud(request, options)
createPrivateCloud(request?: protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location to create the new
* private cloud in. Resource names are schemeless URIs that follow the
* conventions in https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the private cloud to be created.
* This identifier must be unique among each `PrivateCloud` within the parent
* and becomes the final token in the name URI.
* The identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const privateCloudId = 'abc123'
/**
* Required. The initial description of the new private cloud.
*/
// const privateCloud = {}
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. True if you want the request to be validated and not executed;
* false otherwise.
*/
// const validateOnly = true
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreatePrivateCloud() {
// Construct request
const request = {
parent,
privateCloudId,
privateCloud,
};
// Run request
const [operation] = await vmwareengineClient.createPrivateCloud(request);
const [response] = await operation.promise();
console.log(response);
}
callCreatePrivateCloud();
createPrivateCloud(request, options, callback)
createPrivateCloud(request: protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createPrivateCloud(request, callback)
createPrivateCloud(request: protos.google.cloud.vmwareengine.v1.ICreatePrivateCloudRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createPrivateConnection(request, options)
createPrivateConnection(request?: protos.google.cloud.vmwareengine.v1.ICreatePrivateConnectionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new private connection that can be used for accessing private Clouds.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location to create the new private
* connection in. Private connection is a regional resource.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/us-central1`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the new private connection.
* This identifier must be unique among private connection resources
* within the parent and becomes the final token in the name URI. The
* identifier must meet the following requirements:
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const privateConnectionId = 'abc123'
/**
* Required. The initial description of the new private connection.
*/
// const privateConnection = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreatePrivateConnection() {
// Construct request
const request = {
parent,
privateConnectionId,
privateConnection,
};
// Run request
const [operation] = await vmwareengineClient.createPrivateConnection(request);
const [response] = await operation.promise();
console.log(response);
}
callCreatePrivateConnection();
createPrivateConnection(request, options, callback)
createPrivateConnection(request: protos.google.cloud.vmwareengine.v1.ICreatePrivateConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createPrivateConnection(request, callback)
createPrivateConnection(request: protos.google.cloud.vmwareengine.v1.ICreatePrivateConnectionRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createVmwareEngineNetwork(request, options)
createVmwareEngineNetwork(request?: protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new VMware Engine network that can be used by a private cloud.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the location to create the new VMware Engine
* network in. A VMware Engine network of type
* `LEGACY` is a regional resource, and a VMware
* Engine network of type `STANDARD` is a global resource.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global`
*/
// const parent = 'abc123'
/**
* Required. The user-provided identifier of the new VMware Engine network.
* This identifier must be unique among VMware Engine network resources
* within the parent and becomes the final token in the name URI. The
* identifier must meet the following requirements:
* * For networks of type LEGACY, adheres to the format:
* `{region-id}-default`. Replace `{region-id}` with the region where you want
* to create the VMware Engine network. For example, "us-central1-default".
* * Only contains 1-63 alphanumeric characters and hyphens
* * Begins with an alphabetical character
* * Ends with a non-hyphen character
* * Not formatted as a UUID
* * Complies with RFC 1034 (https://datatracker.ietf.org/doc/html/rfc1034)
* (section 3.5)
*/
// const vmwareEngineNetworkId = 'abc123'
/**
* Required. The initial description of the new VMware Engine network.
*/
// const vmwareEngineNetwork = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callCreateVmwareEngineNetwork() {
// Construct request
const request = {
parent,
vmwareEngineNetworkId,
vmwareEngineNetwork,
};
// Run request
const [operation] = await vmwareengineClient.createVmwareEngineNetwork(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateVmwareEngineNetwork();
createVmwareEngineNetwork(request, options, callback)
createVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createVmwareEngineNetwork(request, callback)
createVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.ICreateVmwareEngineNetworkRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteCluster(request, options)
deleteCluster(request?: protos.google.cloud.vmwareengine.v1.IDeleteClusterRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a Cluster
resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.
Parameters |
---|
Name | Description |
request |
IDeleteClusterRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the cluster to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
*/
// const name = 'abc123'
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteCluster() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCluster();
deleteCluster(request, options, callback)
deleteCluster(request: protos.google.cloud.vmwareengine.v1.IDeleteClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteCluster(request, callback)
deleteCluster(request: protos.google.cloud.vmwareengine.v1.IDeleteClusterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteExternalAccessRule(request, options)
deleteExternalAccessRule(request?: protos.google.cloud.vmwareengine.v1.IDeleteExternalAccessRuleRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a single external access rule.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the external access firewall rule to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if the original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteExternalAccessRule() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteExternalAccessRule(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteExternalAccessRule();
deleteExternalAccessRule(request, options, callback)
deleteExternalAccessRule(request: protos.google.cloud.vmwareengine.v1.IDeleteExternalAccessRuleRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteExternalAccessRule(request, callback)
deleteExternalAccessRule(request: protos.google.cloud.vmwareengine.v1.IDeleteExternalAccessRuleRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteExternalAddress(request, options)
deleteExternalAddress(request?: protos.google.cloud.vmwareengine.v1.IDeleteExternalAddressRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a single external IP address. When you delete an external IP address, connectivity between the external IP address and the corresponding internal IP address is lost.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the external IP address to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-ip`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if the original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteExternalAddress() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteExternalAddress(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteExternalAddress();
deleteExternalAddress(request, options, callback)
deleteExternalAddress(request: protos.google.cloud.vmwareengine.v1.IDeleteExternalAddressRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteExternalAddress(request, callback)
deleteExternalAddress(request: protos.google.cloud.vmwareengine.v1.IDeleteExternalAddressRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteLoggingServer(request, options)
deleteLoggingServer(request?: protos.google.cloud.vmwareengine.v1.IDeleteLoggingServerRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a single logging server.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the logging server to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/loggingServers/my-logging-server`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteLoggingServer() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteLoggingServer(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteLoggingServer();
deleteLoggingServer(request, options, callback)
deleteLoggingServer(request: protos.google.cloud.vmwareengine.v1.IDeleteLoggingServerRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteLoggingServer(request, callback)
deleteLoggingServer(request: protos.google.cloud.vmwareengine.v1.IDeleteLoggingServerRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteManagementDnsZoneBinding(request, options)
deleteManagementDnsZoneBinding(request?: protos.google.cloud.vmwareengine.v1.IDeleteManagementDnsZoneBindingRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a ManagementDnsZoneBinding
resource. When a management DNS zone binding is deleted, the corresponding consumer VPC network is no longer bound to the management DNS zone.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the management DNS zone binding to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if the original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteManagementDnsZoneBinding() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteManagementDnsZoneBinding(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteManagementDnsZoneBinding();
deleteManagementDnsZoneBinding(request, options, callback)
deleteManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.IDeleteManagementDnsZoneBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteManagementDnsZoneBinding(request, callback)
deleteManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.IDeleteManagementDnsZoneBindingRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteNetworkPeering(request, options)
deleteNetworkPeering(request?: protos.google.cloud.vmwareengine.v1.IDeleteNetworkPeeringRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a NetworkPeering
resource. When a network peering is deleted for a VMware Engine network, the peer network becomes inaccessible to that VMware Engine network. NetworkPeering is a global resource and location can only be global.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network peering to be deleted.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/global/networkPeerings/my-peering`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteNetworkPeering() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteNetworkPeering(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteNetworkPeering();
deleteNetworkPeering(request, options, callback)
deleteNetworkPeering(request: protos.google.cloud.vmwareengine.v1.IDeleteNetworkPeeringRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteNetworkPeering(request, callback)
deleteNetworkPeering(request: protos.google.cloud.vmwareengine.v1.IDeleteNetworkPeeringRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteNetworkPolicy(request, options)
deleteNetworkPolicy(request?: protos.google.cloud.vmwareengine.v1.IDeleteNetworkPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a NetworkPolicy
resource. A network policy cannot be deleted when NetworkService.state
is set to RECONCILING
for either its external IP or internet access service.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network policy to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteNetworkPolicy() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteNetworkPolicy(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteNetworkPolicy();
deleteNetworkPolicy(request, options, callback)
deleteNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IDeleteNetworkPolicyRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteNetworkPolicy(request, callback)
deleteNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IDeleteNetworkPolicyRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Example
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
deletePrivateCloud(request, options)
deletePrivateCloud(request?: protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Schedules a PrivateCloud
resource for deletion.
A PrivateCloud
resource scheduled for deletion has PrivateCloud.state
set to DELETED
and expireTime
set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the PrivateCloud
is successfully scheduled for deletion (this also applies when delayHours
is set to zero), and the operation is not kept in pending state until PrivateCloud
is purged. PrivateCloud
can be restored using UndeletePrivateCloud
method before the expireTime
elapses. When expireTime
is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, PrivateCloud.state
is set to PURGING
. PrivateCloud
can be polled using standard GET
method for the whole period of deletion and purging. It will not be returned only when it is completely purged.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private cloud to delete.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`
*/
// const name = 'abc123'
/**
* Optional. The request ID must be a valid UUID with the exception that zero
* UUID is not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. If set to true, cascade delete is enabled and all children of
* this private cloud resource are also deleted. When this flag is set to
* false, the private cloud will not be deleted if there are any children
* other than the management cluster. The management cluster is always
* deleted.
*/
// const force = true
/**
* Optional. Time delay of the deletion specified in hours. The default value
* is `3`. Specifying a non-zero value for this field changes the value of
* `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned
* deletion time. Deletion can be cancelled before `expire_time` elapses using
* VmwareEngine.UndeletePrivateCloud google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud.
* Specifying a value of `0` for this field instead begins the deletion
* process and ceases billing immediately. During the final deletion process,
* the value of `PrivateCloud.state` becomes `PURGING`.
*/
// const delayHours = 1234
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeletePrivateCloud() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deletePrivateCloud(request);
const [response] = await operation.promise();
console.log(response);
}
callDeletePrivateCloud();
deletePrivateCloud(request, options, callback)
deletePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deletePrivateCloud(request, callback)
deletePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IDeletePrivateCloudRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deletePrivateConnection(request, options)
deletePrivateConnection(request?: protos.google.cloud.vmwareengine.v1.IDeletePrivateConnectionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a PrivateConnection
resource. When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the private connection to be deleted.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/privateConnections/my-connection`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeletePrivateConnection() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deletePrivateConnection(request);
const [response] = await operation.promise();
console.log(response);
}
callDeletePrivateConnection();
deletePrivateConnection(request, options, callback)
deletePrivateConnection(request: protos.google.cloud.vmwareengine.v1.IDeletePrivateConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deletePrivateConnection(request, callback)
deletePrivateConnection(request: protos.google.cloud.vmwareengine.v1.IDeletePrivateConnectionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteVmwareEngineNetwork(request, options)
deleteVmwareEngineNetwork(request?: protos.google.cloud.vmwareengine.v1.IDeleteVmwareEngineNetworkRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a VmwareEngineNetwork
resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the VMware Engine network to be deleted.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/global/vmwareEngineNetworks/my-network`
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server guarantees that a
* request doesn't result in creation of duplicate commitments for at least 60
* minutes.
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. Checksum used to ensure that the user-provided value is up to
* date before the server processes the request. The server compares provided
* checksum with the current checksum of the resource. If the user-provided
* value is out of date, this request returns an `ABORTED` error.
*/
// const etag = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callDeleteVmwareEngineNetwork() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await vmwareengineClient.deleteVmwareEngineNetwork(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteVmwareEngineNetwork();
deleteVmwareEngineNetwork(request, options, callback)
deleteVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IDeleteVmwareEngineNetworkRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteVmwareEngineNetwork(request, callback)
deleteVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IDeleteVmwareEngineNetworkRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
dnsBindPermissionPath(project, location)
dnsBindPermissionPath(project: string, location: string): string;
Return a fully-qualified dnsBindPermission resource name string.
Parameters |
---|
Name | Description |
project |
string
|
location |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
dnsForwardingPath(project, location, privateCloud)
dnsForwardingPath(project: string, location: string, privateCloud: string): string;
Return a fully-qualified dnsForwarding resource name string.
Parameters |
---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
externalAccessRulePath(project, location, networkPolicy, externalAccessRule)
externalAccessRulePath(project: string, location: string, networkPolicy: string, externalAccessRule: string): string;
Return a fully-qualified externalAccessRule resource name string.
Parameters |
---|
Name | Description |
project |
string
|
location |
string
|
networkPolicy |
string
|
externalAccessRule |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
externalAddressPath(project, location, privateCloud, externalAddress)
externalAddressPath(project: string, location: string, privateCloud: string, externalAddress: string): string;
Return a fully-qualified externalAddress resource name string.
Parameters |
---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
externalAddress |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
fetchNetworkPolicyExternalAddresses(request, options)
fetchNetworkPolicyExternalAddresses(request?: protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAddress[],
protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest | null,
protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesResponse
]>;
Lists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.
fetchNetworkPolicyExternalAddresses(request, options, callback)
fetchNetworkPolicyExternalAddresses(request: protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest, protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAddress>): void;
Returns |
---|
Type | Description |
void | |
fetchNetworkPolicyExternalAddresses(request, callback)
fetchNetworkPolicyExternalAddresses(request: protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest, protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAddress>): void;
Returns |
---|
Type | Description |
void | |
fetchNetworkPolicyExternalAddressesAsync(request, options)
fetchNetworkPolicyExternalAddressesAsync(request?: protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IExternalAddress>;
Equivalent to fetchNetworkPolicyExternalAddresses
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Returns |
---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IExternalAddress> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network policy to query for assigned
* external IP addresses. Resource names are schemeless URIs that follow the
* conventions in https://cloud.google.com/apis/design/resource_names. For
* example:
* `projects/my-project/locations/us-central1/networkPolicies/my-policy`
*/
// const networkPolicy = 'abc123'
/**
* The maximum number of external IP addresses to return in one page.
* The service may return fewer than this value.
* The maximum value is coerced to 1000.
* The default value of this field is 500.
*/
// const pageSize = 1234
/**
* A page token, received from a previous
* `FetchNetworkPolicyExternalAddresses` call. Provide this to retrieve the
* subsequent page.
* When paginating, all parameters provided to
* `FetchNetworkPolicyExternalAddresses`, except for `page_size` and
* `page_token`, must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callFetchNetworkPolicyExternalAddresses() {
// Construct request
const request = {
networkPolicy,
};
// Run request
const iterable = await vmwareengineClient.fetchNetworkPolicyExternalAddressesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callFetchNetworkPolicyExternalAddresses();
fetchNetworkPolicyExternalAddressesStream(request, options)
fetchNetworkPolicyExternalAddressesStream(request?: protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using fetchNetworkPolicyExternalAddressesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
getCluster(request, options)
getCluster(request?: protos.google.cloud.vmwareengine.v1.IGetClusterRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.ICluster,
protos.google.cloud.vmwareengine.v1.IGetClusterRequest | undefined,
{} | undefined
]>;
Retrieves a Cluster
resource by its resource name.
Parameters |
---|
Name | Description |
request |
IGetClusterRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The cluster resource name to retrieve.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetCluster() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getCluster(request);
console.log(response);
}
callGetCluster();
getCluster(request, options, callback)
getCluster(request: protos.google.cloud.vmwareengine.v1.IGetClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IGetClusterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getCluster(request, callback)
getCluster(request: protos.google.cloud.vmwareengine.v1.IGetClusterRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IGetClusterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDnsBindPermission(request, options)
getDnsBindPermission(request?: protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IDnsBindPermission,
(protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest | undefined),
{} | undefined
]>;
Gets all the principals having bind permission on the intranet VPC associated with the consumer project granted by the Grant API. DnsBindPermission is a global resource and location can only be global.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource which stores the users/service accounts
* having the permission to bind to the corresponding intranet VPC of the
* consumer project. DnsBindPermission is a global resource. Resource names
* are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names. For example:
* `projects/my-project/locations/global/dnsBindPermission`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetDnsBindPermission() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getDnsBindPermission(request);
console.log(response);
}
callGetDnsBindPermission();
getDnsBindPermission(request, options, callback)
getDnsBindPermission(request: protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDnsBindPermission(request, callback)
getDnsBindPermission(request: protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDnsForwarding(request, options)
getDnsForwarding(request?: protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IDnsForwarding,
protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest | undefined,
{} | undefined
]>;
Gets details of the DnsForwarding
config.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of a `DnsForwarding` to retrieve.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/dnsForwarding`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetDnsForwarding() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getDnsForwarding(request);
console.log(response);
}
callGetDnsForwarding();
getDnsForwarding(request, options, callback)
getDnsForwarding(request: protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDnsForwarding(request, callback)
getDnsForwarding(request: protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getExternalAccessRule(request, options)
getExternalAccessRule(request?: protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAccessRule,
(protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest | undefined),
{} | undefined
]>;
Gets details of a single external access rule.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the external access firewall rule to
* retrieve. Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/networkPolicies/my-policy/externalAccessRules/my-rule`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetExternalAccessRule() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getExternalAccessRule(request);
console.log(response);
}
callGetExternalAccessRule();
getExternalAccessRule(request, options, callback)
getExternalAccessRule(request: protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getExternalAccessRule(request, callback)
getExternalAccessRule(request: protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getExternalAddress(request, options)
getExternalAddress(request?: protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAddress,
(protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest | undefined),
{} | undefined
]>;
Gets details of a single external IP address.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the external IP address to retrieve.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-ip`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetExternalAddress() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getExternalAddress(request);
console.log(response);
}
callGetExternalAddress();
getExternalAddress(request, options, callback)
getExternalAddress(request: protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getExternalAddress(request, callback)
getExternalAddress(request: protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getHcxActivationKey(request, options)
getHcxActivationKey(request?: protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IHcxActivationKey,
(protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | undefined),
{} | undefined
]>;
Retrieves a HcxActivationKey
resource by its resource name.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the HCX activation key to retrieve.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetHcxActivationKey() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getHcxActivationKey(request);
console.log(response);
}
callGetHcxActivationKey();
getHcxActivationKey(request, options, callback)
getHcxActivationKey(request: protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getHcxActivationKey(request, callback)
getHcxActivationKey(request: protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getIamPolicy(request, options, callback)
getIamPolicy(request: IamProtos.google.iam.v1.GetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters |
---|
Name | Description |
request |
IamProtos.google.iam.v1.GetIamPolicyRequest
The request object that will be sent.
|
options |
CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
|
callback |
Callback<google.iam.v1.Policy, google.iam.v1.GetIamPolicyRequest | null | undefined, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing .
|
Returns |
---|
Type | Description |
Promise<[google.iam.v1.Policy]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
|
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
Gets information about a location.
Parameters |
---|
Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
|
options |
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
|
callback |
Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
Promise<google.cloud.location.ILocation> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
|
Example
const [response] = await client.getLocation(request);
getLoggingServer(request, options)
getLoggingServer(request?: protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.ILoggingServer,
protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest | undefined,
{} | undefined
]>;
Gets details of a logging server.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the Logging Server to retrieve.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/loggingServers/my-logging-server`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetLoggingServer() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getLoggingServer(request);
console.log(response);
}
callGetLoggingServer();
getLoggingServer(request, options, callback)
getLoggingServer(request: protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getLoggingServer(request, callback)
getLoggingServer(request: protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getManagementDnsZoneBinding(request, options)
getManagementDnsZoneBinding(request?: protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding,
(protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest | undefined),
{} | undefined
]>;
Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the management DNS zone binding to
* retrieve. Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/managementDnsZoneBindings/my-management-dns-zone-binding`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetManagementDnsZoneBinding() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getManagementDnsZoneBinding(request);
console.log(response);
}
callGetManagementDnsZoneBinding();
getManagementDnsZoneBinding(request, options, callback)
getManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getManagementDnsZoneBinding(request, callback)
getManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getNetworkPeering(request, options)
getNetworkPeering(request?: protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.INetworkPeering,
protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest | undefined,
{} | undefined
]>;
Retrieves a NetworkPeering
resource by its resource name. The resource contains details of the network peering, such as peered networks, import and export custom route configurations, and peering state. NetworkPeering is a global resource and location can only be global.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network peering to retrieve.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/global/networkPeerings/my-peering`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetNetworkPeering() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getNetworkPeering(request);
console.log(response);
}
callGetNetworkPeering();
getNetworkPeering(request, options, callback)
getNetworkPeering(request: protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getNetworkPeering(request, callback)
getNetworkPeering(request: protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getNetworkPolicy(request, options)
getNetworkPolicy(request?: protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.INetworkPolicy,
protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | undefined,
{} | undefined
]>;
Retrieves a NetworkPolicy
resource by its resource name.
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the network policy to retrieve.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetNetworkPolicy() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getNetworkPolicy(request);
console.log(response);
}
callGetNetworkPolicy();
getNetworkPolicy(request, options, callback)
getNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getNetworkPolicy(request, callback)
getNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getNode(request, options)
getNode(request?: protos.google.cloud.vmwareengine.v1.IGetNodeRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.INode,
protos.google.cloud.vmwareengine.v1.IGetNodeRequest | undefined,
{} | undefined
]>;
Gets details of a single node.
Parameters |
---|
Name | Description |
request |
IGetNodeRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the node to retrieve.
* For example:
* `projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetNode() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getNode(request);
console.log(response);
}
callGetNode();
getNode(request, options, callback)
getNode(request: protos.google.cloud.vmwareengine.v1.IGetNodeRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.INode, protos.google.cloud.vmwareengine.v1.IGetNodeRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getNode(request, callback)
getNode(request: protos.google.cloud.vmwareengine.v1.IGetNodeRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.INode, protos.google.cloud.vmwareengine.v1.IGetNodeRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getNodeType(request, options)
getNodeType(request?: protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.INodeType,
protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | undefined,
{} | undefined
]>;
Gets details of a single NodeType
.
Parameters |
---|
Name | Description |
request |
IGetNodeTypeRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|