VMwareEngine manages VMware's private clusters in the Cloud. v1
Package
@google-cloud/vmwareengineConstructors
(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 |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
iamClient
iamClient: 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
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
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<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.Cluster, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.ExternalAccessRule, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.ExternalAddress, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.HcxActivationKey, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.LoggingServer, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.ManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPeering, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPolicy, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateConnection, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.VmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.DnsBindPermission, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.ManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.DnsBindPermission, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.Cluster, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.DnsForwarding, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.ExternalAccessRule, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.ExternalAddress, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.LoggingServer, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.ManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPeering, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.NetworkPolicy, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateCloud, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.PrivateConnection, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.Subnet, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.vmwareengine.v1.VmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* 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()
close(): Promise<void>;
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
]>;
Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient [node quota](https://cloud.google.com/vmware-engine/quotas).
Parameters | |
---|---|
Name | Description |
request |
ICreateClusterRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateClusterRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
ICreateExternalAccessRuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateExternalAccessRuleRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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
).
Parameters | |
---|---|
Name | Description |
request |
ICreateExternalAddressRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateExternalAddressRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
ICreateHcxActivationKeyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateHcxActivationKeyRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
ICreateLoggingServerRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateLoggingServerRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
ICreateManagementDnsZoneBindingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateManagementDnsZoneBindingRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
ICreateNetworkPeeringRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateNetworkPeeringRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
ICreateNetworkPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateNetworkPolicyRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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
]>;
Creates a new PrivateCloud
resource in a given project and location. Private clouds of type STANDARD
and TIME_LIMITED
are zonal resources, STRETCHED
private clouds are regional. Creating a private cloud also creates a [management cluster](https://cloud.google.com/vmware-engine/docs/concepts-vmware-components) for that private cloud.
Parameters | |
---|---|
Name | Description |
request |
ICreatePrivateCloudRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreatePrivateCloudRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
ICreatePrivateConnectionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreatePrivateConnectionRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
ICreateVmwareEngineNetworkRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
ICreateVmwareEngineNetworkRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteClusterRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteClusterRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IDeleteExternalAccessRuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteExternalAccessRuleRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteExternalAccessRuleRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IDeleteExternalAddressRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteExternalAddressRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteExternalAddressRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IDeleteLoggingServerRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteLoggingServerRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteLoggingServerRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IDeleteManagementDnsZoneBindingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteManagementDnsZoneBindingRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteManagementDnsZoneBindingRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IDeleteNetworkPeeringRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteNetworkPeeringRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteNetworkPeeringRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IDeleteNetworkPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteNetworkPolicyRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteNetworkPolicyRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | 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<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
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.
Parameters | |
---|---|
Name | Description |
request |
IDeletePrivateCloudRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeletePrivateCloudRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IDeletePrivateConnectionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeletePrivateConnectionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeletePrivateConnectionRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IDeleteVmwareEngineNetworkRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteVmwareEngineNetworkRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IDeleteVmwareEngineNetworkRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IFetchNetworkPolicyExternalAddressesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAddress[],
protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest | null,
protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
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;
Parameters | |
---|---|
Name | Description |
request |
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>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IFetchNetworkPolicyExternalAddressesRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesRequest, protos.google.cloud.vmwareengine.v1.IFetchNetworkPolicyExternalAddressesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAddress>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IFetchNetworkPolicyExternalAddressesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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. |
/**
* 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.
Parameters | |
---|---|
Name | Description |
request |
IFetchNetworkPolicyExternalAddressesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
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. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.ICluster,
protos.google.cloud.vmwareengine.v1.IGetClusterRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetClusterRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IGetClusterRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetClusterRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IGetClusterRequest | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IGetDnsBindPermissionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IDnsBindPermission,
(protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing DnsBindPermission. Please see the documentation for more details and examples. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetDnsBindPermissionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetDnsBindPermissionRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IGetDnsBindPermissionRequest | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IGetDnsForwardingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IDnsForwarding,
protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetDnsForwardingRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetDnsForwardingRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IGetDnsForwardingRequest | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IGetExternalAccessRuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAccessRule,
(protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest | undefined),
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetExternalAccessRuleRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetExternalAccessRuleRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IGetExternalAccessRuleRequest | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IGetExternalAddressRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAddress,
(protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest | undefined),
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetExternalAddressRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetExternalAddressRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IGetExternalAddressRequest | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IGetHcxActivationKeyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IHcxActivationKey,
(protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | undefined),
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetHcxActivationKeyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetHcxActivationKeyRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IHcxActivationKey, protos.google.cloud.vmwareengine.v1.IGetHcxActivationKeyRequest | null | undefined, {} | null | undefined>
|
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. |
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.
Parameters | |
---|---|
Name | Description |
request |
IGetLoggingServerRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.ILoggingServer,
protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetLoggingServerRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetLoggingServerRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IGetLoggingServerRequest | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IGetManagementDnsZoneBindingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding,
(protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest | undefined),
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetManagementDnsZoneBindingRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetManagementDnsZoneBindingRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IGetManagementDnsZoneBindingRequest | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IGetNetworkPeeringRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.INetworkPeering,
protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetNetworkPeeringRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetNetworkPeeringRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IGetNetworkPeeringRequest | null | undefined, {} | null | undefined>
|
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.
Parameters | |
---|---|
Name | Description |
request |
IGetNetworkPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.INetworkPolicy,
protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetNetworkPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetNetworkPolicyRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IGetNetworkPolicyRequest | null | undefined, {} | null | undefined>
|
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. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.INode,
protos.google.cloud.vmwareengine.v1.IGetNodeRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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;
Parameters | |
---|---|
Name | Description |
request |
IGetNodeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.INode, protos.google.cloud.vmwareengine.v1.IGetNodeRequest | null | undefined, {} | null | undefined>
|
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;
Parameters | |
---|---|
Name | Description |
request |
IGetNodeRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.INode, protos.google.cloud.vmwareengine.v1.IGetNodeRequest | null | undefined, {} | null | undefined>
|
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. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.INodeType,
protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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 type to retrieve.
* Resource names are schemeless URIs that follow the conventions in
* https://cloud.google.com/apis/design/resource_names.
* For example:
* `projects/my-proj/locations/us-central1-a/nodeTypes/standard-72`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetNodeType() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getNodeType(request);
console.log(response);
}
callGetNodeType();
getNodeType(request, options, callback)
getNodeType(request: protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetNodeTypeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getNodeType(request, callback)
getNodeType(request: protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetNodeTypeRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.INodeType, protos.google.cloud.vmwareengine.v1.IGetNodeTypeRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | 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<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | 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 . {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. |
Returns | |
---|---|
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getPrivateCloud(request, options)
getPrivateCloud(request?: protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IPrivateCloud,
protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | undefined,
{} | undefined
]>;
Retrieves a PrivateCloud
resource by its resource name.
Parameters | |
---|---|
Name | Description |
request |
IGetPrivateCloudRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IPrivateCloud,
protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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 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`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetPrivateCloud() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getPrivateCloud(request);
console.log(response);
}
callGetPrivateCloud();
getPrivateCloud(request, options, callback)
getPrivateCloud(request: protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetPrivateCloudRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getPrivateCloud(request, callback)
getPrivateCloud(request: protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetPrivateCloudRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IGetPrivateCloudRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getPrivateConnection(request, options)
getPrivateConnection(request?: protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IPrivateConnection,
(protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest | undefined),
{} | undefined
]>;
Retrieves a PrivateConnection
resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.
Parameters | |
---|---|
Name | Description |
request |
IGetPrivateConnectionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IPrivateConnection,
(protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest | undefined),
{} | undefined
]> | {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. |
/**
* 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 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/privateConnections/my-connection`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetPrivateConnection() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getPrivateConnection(request);
console.log(response);
}
callGetPrivateConnection();
getPrivateConnection(request, options, callback)
getPrivateConnection(request: protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetPrivateConnectionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getPrivateConnection(request, callback)
getPrivateConnection(request: protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetPrivateConnectionRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
getSubnet(request, options)
getSubnet(request?: protos.google.cloud.vmwareengine.v1.IGetSubnetRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.ISubnet,
protos.google.cloud.vmwareengine.v1.IGetSubnetRequest | undefined,
{} | undefined
]>;
Gets details of a single subnet.
Parameters | |
---|---|
Name | Description |
request |
IGetSubnetRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.ISubnet,
protos.google.cloud.vmwareengine.v1.IGetSubnetRequest | undefined,
{} | undefined
]> | {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. |
/**
* 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 subnet 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/subnets/my-subnet`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetSubnet() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getSubnet(request);
console.log(response);
}
callGetSubnet();
getSubnet(request, options, callback)
getSubnet(request: protos.google.cloud.vmwareengine.v1.IGetSubnetRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IGetSubnetRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetSubnetRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IGetSubnetRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getSubnet(request, callback)
getSubnet(request: protos.google.cloud.vmwareengine.v1.IGetSubnetRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IGetSubnetRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetSubnetRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IGetSubnetRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getVmwareEngineNetwork(request, options)
getVmwareEngineNetwork(request?: protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork,
(protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | undefined),
{} | undefined
]>;
Retrieves a VmwareEngineNetwork
resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, CREATING
, ACTIVE
, DELETING
).
Parameters | |
---|---|
Name | Description |
request |
IGetVmwareEngineNetworkRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork,
(protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | undefined),
{} | undefined
]> | {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. |
/**
* 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 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/vmwareEngineNetworks/my-network`
*/
// const name = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callGetVmwareEngineNetwork() {
// Construct request
const request = {
name,
};
// Run request
const response = await vmwareengineClient.getVmwareEngineNetwork(request);
console.log(response);
}
callGetVmwareEngineNetwork();
getVmwareEngineNetwork(request, options, callback)
getVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetVmwareEngineNetworkRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getVmwareEngineNetwork(request, callback)
getVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetVmwareEngineNetworkRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IGetVmwareEngineNetworkRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
grantDnsBindPermission(request, options)
grantDnsBindPermission(request?: protos.google.cloud.vmwareengine.v1.IGrantDnsBindPermissionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Grants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the intranet VPC associated with the project. DnsBindPermission is a global resource and location can only be global.
Parameters | |
---|---|
Name | Description |
request |
IGrantDnsBindPermissionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
grantDnsBindPermission(request, options, callback)
grantDnsBindPermission(request: protos.google.cloud.vmwareengine.v1.IGrantDnsBindPermissionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGrantDnsBindPermissionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
grantDnsBindPermission(request, callback)
grantDnsBindPermission(request: protos.google.cloud.vmwareengine.v1.IGrantDnsBindPermissionRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGrantDnsBindPermissionRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
hcxActivationKeyPath(project, location, privateCloud, hcxActivationKey)
hcxActivationKeyPath(project: string, location: string, privateCloud: string, hcxActivationKey: string): string;
Return a fully-qualified hcxActivationKey resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
hcxActivationKey |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns | |
---|---|
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub. |
listClusters(request, options)
listClusters(request?: protos.google.cloud.vmwareengine.v1.IListClustersRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.ICluster[],
protos.google.cloud.vmwareengine.v1.IListClustersRequest | null,
protos.google.cloud.vmwareengine.v1.IListClustersResponse
]>;
Lists Cluster
resources in a given private cloud.
Parameters | |
---|---|
Name | Description |
request |
IListClustersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.ICluster[],
protos.google.cloud.vmwareengine.v1.IListClustersRequest | null,
protos.google.cloud.vmwareengine.v1.IListClustersResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listClusters(request, options, callback)
listClusters(request: protos.google.cloud.vmwareengine.v1.IListClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListClustersRequest, protos.google.cloud.vmwareengine.v1.IListClustersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ICluster>): void;
Parameters | |
---|---|
Name | Description |
request |
IListClustersRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListClustersRequest, protos.google.cloud.vmwareengine.v1.IListClustersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ICluster>
|
Returns | |
---|---|
Type | Description |
void |
listClusters(request, callback)
listClusters(request: protos.google.cloud.vmwareengine.v1.IListClustersRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListClustersRequest, protos.google.cloud.vmwareengine.v1.IListClustersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ICluster>): void;
Parameters | |
---|---|
Name | Description |
request |
IListClustersRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListClustersRequest, protos.google.cloud.vmwareengine.v1.IListClustersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ICluster>
|
Returns | |
---|---|
Type | Description |
void |
listClustersAsync(request, options)
listClustersAsync(request?: protos.google.cloud.vmwareengine.v1.IListClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.ICluster>;
Equivalent to listClusters
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListClustersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.ICluster> | {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. |
/**
* 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 query for clusters.
* 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'
/**
* The maximum number of clusters 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 `ListClusters` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListClusters`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* To filter on multiple expressions, provide each separate expression within
* parentheses. For example:
*
* (name = "example-cluster")
* (nodeCount = "3")
*
- By default, each expression is an
AND
expression. However, you can - include
AND
andOR
expressions explicitly. For example: - (name = "example-cluster-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-cluster-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results are
- ordered by
name
in ascending order. You can also sort results in - descending order based on the
name
value usingorderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListClusters() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listClustersAsync(request); for await (const response of iterable) { console.log(response); } }
callListClusters();
listClustersStream(request, options)
listClustersStream(request?: protos.google.cloud.vmwareengine.v1.IListClustersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListClustersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listExternalAccessRules(request, options)
listExternalAccessRules(request?: protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAccessRule[],
protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest | null,
protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesResponse
]>;
Lists ExternalAccessRule
resources in the specified network policy.
Parameters | |
---|---|
Name | Description |
request |
IListExternalAccessRulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAccessRule[],
protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest | null,
protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listExternalAccessRules(request, options, callback)
listExternalAccessRules(request: protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAccessRule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListExternalAccessRulesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAccessRule>
|
Returns | |
---|---|
Type | Description |
void |
listExternalAccessRules(request, callback)
listExternalAccessRules(request: protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAccessRule>): void;
Parameters | |
---|---|
Name | Description |
request |
IListExternalAccessRulesRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAccessRule>
|
Returns | |
---|---|
Type | Description |
void |
listExternalAccessRulesAsync(request, options)
listExternalAccessRulesAsync(request?: protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IExternalAccessRule>;
Equivalent to listExternalAccessRules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListExternalAccessRulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IExternalAccessRule> | {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. |
/**
* 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 external
* access firewall rules. 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'
/**
* The maximum number of external access rules 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 `ListExternalAccessRulesRequest`
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListExternalAccessRulesRequest` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" external="" access="" rules,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-rule`="" by="" specifying="" *="" `name="" !="example-rule" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-rule")
* (createTime > "2021-04-12T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "example-rule-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-rule-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results
- are ordered by
name
in ascending order. - You can also sort results in descending order based on the
name
value - using
orderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListExternalAccessRules() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listExternalAccessRulesAsync(request); for await (const response of iterable) { console.log(response); } }
callListExternalAccessRules();
listExternalAccessRulesStream(request, options)
listExternalAccessRulesStream(request?: protos.google.cloud.vmwareengine.v1.IListExternalAccessRulesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListExternalAccessRulesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listExternalAddresses(request, options)
listExternalAddresses(request?: protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAddress[],
protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest | null,
protos.google.cloud.vmwareengine.v1.IListExternalAddressesResponse
]>;
Lists external IP addresses assigned to VMware workload VMs in a given private cloud.
Parameters | |
---|---|
Name | Description |
request |
IListExternalAddressesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IExternalAddress[],
protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest | null,
protos.google.cloud.vmwareengine.v1.IListExternalAddressesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listExternalAddresses(request, options, callback)
listExternalAddresses(request: protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, protos.google.cloud.vmwareengine.v1.IListExternalAddressesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAddress>): void;
Parameters | |
---|---|
Name | Description |
request |
IListExternalAddressesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, protos.google.cloud.vmwareengine.v1.IListExternalAddressesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAddress>
|
Returns | |
---|---|
Type | Description |
void |
listExternalAddresses(request, callback)
listExternalAddresses(request: protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, protos.google.cloud.vmwareengine.v1.IListExternalAddressesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAddress>): void;
Parameters | |
---|---|
Name | Description |
request |
IListExternalAddressesRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, protos.google.cloud.vmwareengine.v1.IListExternalAddressesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IExternalAddress>
|
Returns | |
---|---|
Type | Description |
void |
listExternalAddressesAsync(request, options)
listExternalAddressesAsync(request?: protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IExternalAddress>;
Equivalent to listExternalAddresses
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListExternalAddressesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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. |
/**
* 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 be queried for
* 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-a/privateClouds/my-cloud`
*/
// const parent = '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 `ListExternalAddresses` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListExternalAddresses` must match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" ip="" addresses,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-ip`="" by="" specifying="" *="" `name="" !="example-ip" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-ip")
* (createTime > "2021-04-12T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "example-ip-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-ip-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results
- are ordered by
name
in ascending order. - You can also sort results in descending order based on the
name
value - using
orderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListExternalAddresses() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listExternalAddressesAsync(request); for await (const response of iterable) { console.log(response); } }
callListExternalAddresses();
listExternalAddressesStream(request, options)
listExternalAddressesStream(request?: protos.google.cloud.vmwareengine.v1.IListExternalAddressesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListExternalAddressesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listHcxActivationKeys(request, options)
listHcxActivationKeys(request?: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IHcxActivationKey[],
protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest | null,
protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse
]>;
Lists HcxActivationKey
resources in a given private cloud.
Parameters | |
---|---|
Name | Description |
request |
IListHcxActivationKeysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IHcxActivationKey[],
protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest | null,
protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listHcxActivationKeys(request, options, callback)
listHcxActivationKeys(request: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IHcxActivationKey>): void;
Parameters | |
---|---|
Name | Description |
request |
IListHcxActivationKeysRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IHcxActivationKey>
|
Returns | |
---|---|
Type | Description |
void |
listHcxActivationKeys(request, callback)
listHcxActivationKeys(request: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IHcxActivationKey>): void;
Parameters | |
---|---|
Name | Description |
request |
IListHcxActivationKeysRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IHcxActivationKey>
|
Returns | |
---|---|
Type | Description |
void |
listHcxActivationKeysAsync(request, options)
listHcxActivationKeysAsync(request?: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IHcxActivationKey>;
Equivalent to listHcxActivationKeys
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListHcxActivationKeysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IHcxActivationKey> | {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. |
/**
* 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 be queried for HCX activation keys.
* 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'
/**
* The maximum number of HCX activation keys 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 `ListHcxActivationKeys` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListHcxActivationKeys` 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 callListHcxActivationKeys() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await vmwareengineClient.listHcxActivationKeysAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListHcxActivationKeys();
listHcxActivationKeysStream(request, options)
listHcxActivationKeysStream(request?: protos.google.cloud.vmwareengine.v1.IListHcxActivationKeysRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListHcxActivationKeysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
Lists information about the supported locations for this service. Returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<google.cloud.location.ILocation> | {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. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listLoggingServers(request, options)
listLoggingServers(request?: protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.ILoggingServer[],
protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest | null,
protos.google.cloud.vmwareengine.v1.IListLoggingServersResponse
]>;
Lists logging servers configured for a given private cloud.
Parameters | |
---|---|
Name | Description |
request |
IListLoggingServersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.ILoggingServer[],
protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest | null,
protos.google.cloud.vmwareengine.v1.IListLoggingServersResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listLoggingServers(request, options, callback)
listLoggingServers(request: protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, protos.google.cloud.vmwareengine.v1.IListLoggingServersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ILoggingServer>): void;
Parameters | |
---|---|
Name | Description |
request |
IListLoggingServersRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, protos.google.cloud.vmwareengine.v1.IListLoggingServersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ILoggingServer>
|
Returns | |
---|---|
Type | Description |
void |
listLoggingServers(request, callback)
listLoggingServers(request: protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, protos.google.cloud.vmwareengine.v1.IListLoggingServersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ILoggingServer>): void;
Parameters | |
---|---|
Name | Description |
request |
IListLoggingServersRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, protos.google.cloud.vmwareengine.v1.IListLoggingServersResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ILoggingServer>
|
Returns | |
---|---|
Type | Description |
void |
listLoggingServersAsync(request, options)
listLoggingServersAsync(request?: protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.ILoggingServer>;
Equivalent to listLoggingServers
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListLoggingServersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.ILoggingServer> | {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. |
/**
* 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 be queried for
* logging servers.
* 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'
/**
* The maximum number of logging servers 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 `ListLoggingServersRequest` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListLoggingServersRequest` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" logging="" servers,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-server`="" by="" specifying="" *="" `name="" !="example-server" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-server")
* (createTime > "2021-04-12T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "example-server-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-server-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results
- are ordered by
name
in ascending order. - You can also sort results in descending order based on the
name
value - using
orderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListLoggingServers() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listLoggingServersAsync(request); for await (const response of iterable) { console.log(response); } }
callListLoggingServers();
listLoggingServersStream(request, options)
listLoggingServersStream(request?: protos.google.cloud.vmwareengine.v1.IListLoggingServersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListLoggingServersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listManagementDnsZoneBindings(request, options)
listManagementDnsZoneBindings(request?: protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding[],
protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest | null,
protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsResponse
]>;
Lists Consumer VPCs bound to Management DNS Zone of a given private cloud.
Parameters | |
---|---|
Name | Description |
request |
IListManagementDnsZoneBindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding[],
protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest | null,
protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listManagementDnsZoneBindings(request, options, callback)
listManagementDnsZoneBindings(request: protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding>): void;
Parameters | |
---|---|
Name | Description |
request |
IListManagementDnsZoneBindingsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding>
|
Returns | |
---|---|
Type | Description |
void |
listManagementDnsZoneBindings(request, callback)
listManagementDnsZoneBindings(request: protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding>): void;
Parameters | |
---|---|
Name | Description |
request |
IListManagementDnsZoneBindingsRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding>
|
Returns | |
---|---|
Type | Description |
void |
listManagementDnsZoneBindingsAsync(request, options)
listManagementDnsZoneBindingsAsync(request?: protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding>;
Equivalent to listManagementDnsZoneBindings
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListManagementDnsZoneBindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding> | {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. |
/**
* 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 be queried for
* management DNS zone bindings.
* 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'
/**
* The maximum number of management DNS zone bindings 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 `ListManagementDnsZoneBindings`
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListManagementDnsZoneBindings` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" management="" dns="" zone="" bindings,="" *="" you="" can="" exclude="" the="" ones="" named="" `example-management-dns-zone-binding`="" by="" *="" specifying="" `name="" !="example-management-dns-zone-binding" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-management-dns-zone-binding")
* (createTime > "2021-04-12T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "example-management-dns-zone-binding-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-management-dns-zone-binding-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results
- are ordered by
name
in ascending order. - You can also sort results in descending order based on the
name
value - using
orderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListManagementDnsZoneBindings() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listManagementDnsZoneBindingsAsync(request); for await (const response of iterable) { console.log(response); } }
callListManagementDnsZoneBindings();
listManagementDnsZoneBindingsStream(request, options)
listManagementDnsZoneBindingsStream(request?: protos.google.cloud.vmwareengine.v1.IListManagementDnsZoneBindingsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListManagementDnsZoneBindingsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listNetworkPeerings(request, options)
listNetworkPeerings(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.INetworkPeering[],
protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest | null,
protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsResponse
]>;
Lists NetworkPeering
resources in a given project. NetworkPeering is a global resource and location can only be global.
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPeeringsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.INetworkPeering[],
protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest | null,
protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listNetworkPeerings(request, options, callback)
listNetworkPeerings(request: protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPeering>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPeeringsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPeering>
|
Returns | |
---|---|
Type | Description |
void |
listNetworkPeerings(request, callback)
listNetworkPeerings(request: protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPeering>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPeeringsRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPeering>
|
Returns | |
---|---|
Type | Description |
void |
listNetworkPeeringsAsync(request, options)
listNetworkPeeringsAsync(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.INetworkPeering>;
Equivalent to listNetworkPeerings
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPeeringsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.INetworkPeering> | {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. |
/**
* 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 (global) to query for
* network peerings. 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'
/**
* The maximum number of network peerings to return in one page.
* 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 `ListNetworkPeerings` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListNetworkPeerings` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" network="" peerings,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-peering`="" by="" specifying="" *="" `name="" !="example-peering" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-peering")
* (createTime > "2021-04-12T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "example-peering-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-peering-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results
- are ordered by
name
in ascending order. - You can also sort results in descending order based on the
name
value - using
orderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListNetworkPeerings() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listNetworkPeeringsAsync(request); for await (const response of iterable) { console.log(response); } }
callListNetworkPeerings();
listNetworkPeeringsStream(request, options)
listNetworkPeeringsStream(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPeeringsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPeeringsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listNetworkPolicies(request, options)
listNetworkPolicies(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.INetworkPolicy[],
protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest | null,
protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse
]>;
Lists NetworkPolicy
resources in a specified project and location.
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPoliciesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.INetworkPolicy[],
protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest | null,
protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listNetworkPolicies(request, options, callback)
listNetworkPolicies(request: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPolicy>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPoliciesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPolicy>
|
Returns | |
---|---|
Type | Description |
void |
listNetworkPolicies(request, callback)
listNetworkPolicies(request: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPolicy>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPoliciesRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INetworkPolicy>
|
Returns | |
---|---|
Type | Description |
void |
listNetworkPoliciesAsync(request, options)
listNetworkPoliciesAsync(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.INetworkPolicy>;
Equivalent to listNetworkPolicies
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPoliciesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.INetworkPolicy> | {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. |
/**
* 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 query for
* network policies. 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'
/**
* The maximum number of network policies 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 `ListNetworkPolicies` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListNetworkPolicies` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" network="" policies,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-policy`="" by="" specifying="" *="" `name="" !="example-policy" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-policy")
* (createTime > "2021-04-12T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "example-policy-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-policy-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results
- are ordered by
name
in ascending order. - You can also sort results in descending order based on the
name
value - using
orderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListNetworkPolicies() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listNetworkPoliciesAsync(request); for await (const response of iterable) { console.log(response); } }
callListNetworkPolicies();
listNetworkPoliciesStream(request, options)
listNetworkPoliciesStream(request?: protos.google.cloud.vmwareengine.v1.IListNetworkPoliciesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListNetworkPoliciesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listNodes(request, options)
listNodes(request?: protos.google.cloud.vmwareengine.v1.IListNodesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.INode[],
protos.google.cloud.vmwareengine.v1.IListNodesRequest | null,
protos.google.cloud.vmwareengine.v1.IListNodesResponse
]>;
Lists nodes in a given cluster.
Parameters | |
---|---|
Name | Description |
request |
IListNodesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.INode[],
protos.google.cloud.vmwareengine.v1.IListNodesRequest | null,
protos.google.cloud.vmwareengine.v1.IListNodesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listNodes(request, options, callback)
listNodes(request: protos.google.cloud.vmwareengine.v1.IListNodesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodesRequest, protos.google.cloud.vmwareengine.v1.IListNodesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INode>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNodesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodesRequest, protos.google.cloud.vmwareengine.v1.IListNodesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INode>
|
Returns | |
---|---|
Type | Description |
void |
listNodes(request, callback)
listNodes(request: protos.google.cloud.vmwareengine.v1.IListNodesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodesRequest, protos.google.cloud.vmwareengine.v1.IListNodesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INode>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNodesRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodesRequest, protos.google.cloud.vmwareengine.v1.IListNodesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INode>
|
Returns | |
---|---|
Type | Description |
void |
listNodesAsync(request, options)
listNodesAsync(request?: protos.google.cloud.vmwareengine.v1.IListNodesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.INode>;
Equivalent to listNodes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListNodesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.INode> | {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. |
/**
* 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 be queried for nodes.
* 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 parent = 'abc123'
/**
* The maximum number of nodes 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 `ListNodes` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListNodes` 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 callListNodes() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await vmwareengineClient.listNodesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListNodes();
listNodesStream(request, options)
listNodesStream(request?: protos.google.cloud.vmwareengine.v1.IListNodesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListNodesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listNodeTypes(request, options)
listNodeTypes(request?: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.INodeType[],
protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest | null,
protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse
]>;
Lists node types
Parameters | |
---|---|
Name | Description |
request |
IListNodeTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.INodeType[],
protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest | null,
protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listNodeTypes(request, options, callback)
listNodeTypes(request: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INodeType>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNodeTypesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INodeType>
|
Returns | |
---|---|
Type | Description |
void |
listNodeTypes(request, callback)
listNodeTypes(request: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INodeType>): void;
Parameters | |
---|---|
Name | Description |
request |
IListNodeTypesRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, protos.google.cloud.vmwareengine.v1.IListNodeTypesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.INodeType>
|
Returns | |
---|---|
Type | Description |
void |
listNodeTypesAsync(request, options)
listNodeTypesAsync(request?: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.INodeType>;
Equivalent to listNodeTypes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListNodeTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.INodeType> | {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. |
/**
* 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 be queried for node types.
* 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'
/**
* The maximum number of node types 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 `ListNodeTypes` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListNodeTypes` must match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" node="" types,="" you="" can="" *="" exclude="" the="" ones="" named="" `standard-72`="" by="" specifying="" *="" `name="" !="standard-72" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "standard-72")
* (virtual_cpu_count > 2)
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "standard-96") AND
- (virtual_cpu_count > 2) OR
- (name = "standard-72")
*/ // const filter = 'abc123'
// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListNodeTypes() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listNodeTypesAsync(request); for await (const response of iterable) { console.log(response); } }
callListNodeTypes();
listNodeTypesStream(request, options)
listNodeTypesStream(request?: protos.google.cloud.vmwareengine.v1.IListNodeTypesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListNodeTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters | |
---|---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> | {Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
listPeeringRoutes(request, options)
listPeeringRoutes(request?: protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IPeeringRoute[],
protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest | null,
protos.google.cloud.vmwareengine.v1.IListPeeringRoutesResponse
]>;
Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.
Parameters | |
---|---|
Name | Description |
request |
IListPeeringRoutesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IPeeringRoute[],
protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest | null,
protos.google.cloud.vmwareengine.v1.IListPeeringRoutesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listPeeringRoutes(request, options, callback)
listPeeringRoutes(request: protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, protos.google.cloud.vmwareengine.v1.IListPeeringRoutesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPeeringRoute>): void;
Parameters | |
---|---|
Name | Description |
request |
IListPeeringRoutesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, protos.google.cloud.vmwareengine.v1.IListPeeringRoutesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPeeringRoute>
|
Returns | |
---|---|
Type | Description |
void |
listPeeringRoutes(request, callback)
listPeeringRoutes(request: protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, protos.google.cloud.vmwareengine.v1.IListPeeringRoutesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPeeringRoute>): void;
Parameters | |
---|---|
Name | Description |
request |
IListPeeringRoutesRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, protos.google.cloud.vmwareengine.v1.IListPeeringRoutesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPeeringRoute>
|
Returns | |
---|---|
Type | Description |
void |
listPeeringRoutesAsync(request, options)
listPeeringRoutesAsync(request?: protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IPeeringRoute>;
Equivalent to listPeeringRoutes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListPeeringRoutesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IPeeringRoute> | {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. |
/**
* 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 peering
* routes from. 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 parent = 'abc123'
/**
* The maximum number of peering routes 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 `ListPeeringRoutes` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListPeeringRoutes` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* Currently, only filtering on the `direction` field is supported. To return
* routes imported from the peer network, provide "direction=INCOMING". To
* return routes exported from the VMware Engine network, provide
* "direction=OUTGOING". Other filter expressions return an error.
*/
// const filter = 'abc123'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callListPeeringRoutes() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await vmwareengineClient.listPeeringRoutesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPeeringRoutes();
listPeeringRoutesStream(request, options)
listPeeringRoutesStream(request?: protos.google.cloud.vmwareengine.v1.IListPeeringRoutesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListPeeringRoutesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listPrivateClouds(request, options)
listPrivateClouds(request?: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IPrivateCloud[],
protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest | null,
protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse
]>;
Lists PrivateCloud
resources in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateCloudsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IPrivateCloud[],
protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest | null,
protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listPrivateClouds(request, options, callback)
listPrivateClouds(request: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateCloud>): void;
Parameters | |
---|---|
Name | Description |
request |
IListPrivateCloudsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateCloud>
|
Returns | |
---|---|
Type | Description |
void |
listPrivateClouds(request, callback)
listPrivateClouds(request: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateCloud>): void;
Parameters | |
---|---|
Name | Description |
request |
IListPrivateCloudsRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateCloudsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateCloud>
|
Returns | |
---|---|
Type | Description |
void |
listPrivateCloudsAsync(request, options)
listPrivateCloudsAsync(request?: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IPrivateCloud>;
Equivalent to listPrivateClouds
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateCloudsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IPrivateCloud> | {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. |
/**
* 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 be queried for
* clusters. 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'
/**
* The maximum number of private clouds 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 `ListPrivateClouds` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListPrivateClouds` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison operator, and the
* value that you want to use for filtering. The value must be a string, a
* number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or
* `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" private="" clouds,="" you="" can="" exclude="" *="" the="" ones="" named="" `example-pc`="" by="" specifying="" `name="" !="example-pc" `.="" *="" you="" can="" also="" filter="" nested="" fields.="" for="" example,="" you="" could="" specify="" *="" `networkconfig.managementcidr="192.168.0.0/24" `="" to="" include="" private="" clouds="" *="" only="" if="" they="" have="" a="" matching="" address="" in="" their="" network="" configuration.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-pc")
* (createTime > "2021-04-12T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you can - include
AND
andOR
expressions explicitly. For example: - (name = "private-cloud-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "private-cloud-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results are
- ordered by
name
in ascending order. You can also sort results in - descending order based on the
name
value usingorderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListPrivateClouds() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listPrivateCloudsAsync(request); for await (const response of iterable) { console.log(response); } }
callListPrivateClouds();
listPrivateCloudsStream(request, options)
listPrivateCloudsStream(request?: protos.google.cloud.vmwareengine.v1.IListPrivateCloudsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateCloudsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listPrivateConnectionPeeringRoutes(request, options)
listPrivateConnectionPeeringRoutes(request?: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IPeeringRoute[],
protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest | null,
protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesResponse
]>;
Lists the private connection routes exchanged over a peering connection.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionPeeringRoutesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IPeeringRoute[],
protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest | null,
protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listPrivateConnectionPeeringRoutes(request, options, callback)
listPrivateConnectionPeeringRoutes(request: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPeeringRoute>): void;
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionPeeringRoutesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPeeringRoute>
|
Returns | |
---|---|
Type | Description |
void |
listPrivateConnectionPeeringRoutes(request, callback)
listPrivateConnectionPeeringRoutes(request: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPeeringRoute>): void;
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionPeeringRoutesRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPeeringRoute>
|
Returns | |
---|---|
Type | Description |
void |
listPrivateConnectionPeeringRoutesAsync(request, options)
listPrivateConnectionPeeringRoutesAsync(request?: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IPeeringRoute>;
Equivalent to listPrivateConnectionPeeringRoutes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionPeeringRoutesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IPeeringRoute> | {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. |
/**
* 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 retrieve peering
* routes from. 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-west1/privateConnections/my-connection`
*/
// const parent = 'abc123'
/**
* The maximum number of peering routes 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 `ListPrivateConnectionPeeringRoutes`
* call. Provide this to retrieve the subsequent page. When paginating, all
* other parameters provided to `ListPrivateConnectionPeeringRoutes` 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 callListPrivateConnectionPeeringRoutes() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await vmwareengineClient.listPrivateConnectionPeeringRoutesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPrivateConnectionPeeringRoutes();
listPrivateConnectionPeeringRoutesStream(request, options)
listPrivateConnectionPeeringRoutesStream(request?: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionPeeringRoutesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionPeeringRoutesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listPrivateConnections(request, options)
listPrivateConnections(request?: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IPrivateConnection[],
protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest | null,
protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsResponse
]>;
Lists PrivateConnection
resources in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IPrivateConnection[],
protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest | null,
protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listPrivateConnections(request, options, callback)
listPrivateConnections(request: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateConnection>): void;
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateConnection>
|
Returns | |
---|---|
Type | Description |
void |
listPrivateConnections(request, callback)
listPrivateConnections(request: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateConnection>): void;
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionsRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IPrivateConnection>
|
Returns | |
---|---|
Type | Description |
void |
listPrivateConnectionsAsync(request, options)
listPrivateConnectionsAsync(request?: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IPrivateConnection>;
Equivalent to listPrivateConnections
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IPrivateConnection> | {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. |
/**
* 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 query for
* private connections. 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'
/**
* The maximum number of private connections to return in one page.
* 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 `ListPrivateConnections` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListPrivateConnections` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" private="" connections,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-connection`="" by="" specifying="" *="" `name="" !="example-connection" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-connection")
* (createTime > "2022-09-22T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "example-connection-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-connection-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results
- are ordered by
name
in ascending order. - You can also sort results in descending order based on the
name
value - using
orderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListPrivateConnections() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listPrivateConnectionsAsync(request); for await (const response of iterable) { console.log(response); } }
callListPrivateConnections();
listPrivateConnectionsStream(request, options)
listPrivateConnectionsStream(request?: protos.google.cloud.vmwareengine.v1.IListPrivateConnectionsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListPrivateConnectionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listSubnets(request, options)
listSubnets(request?: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.ISubnet[],
protos.google.cloud.vmwareengine.v1.IListSubnetsRequest | null,
protos.google.cloud.vmwareengine.v1.IListSubnetsResponse
]>;
Lists subnets in a given private cloud.
Parameters | |
---|---|
Name | Description |
request |
IListSubnetsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.ISubnet[],
protos.google.cloud.vmwareengine.v1.IListSubnetsRequest | null,
protos.google.cloud.vmwareengine.v1.IListSubnetsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listSubnets(request, options, callback)
listSubnets(request: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ISubnet>): void;
Parameters | |
---|---|
Name | Description |
request |
IListSubnetsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ISubnet>
|
Returns | |
---|---|
Type | Description |
void |
listSubnets(request, callback)
listSubnets(request: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ISubnet>): void;
Parameters | |
---|---|
Name | Description |
request |
IListSubnetsRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, protos.google.cloud.vmwareengine.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.vmwareengine.v1.ISubnet>
|
Returns | |
---|---|
Type | Description |
void |
listSubnetsAsync(request, options)
listSubnetsAsync(request?: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.ISubnet>;
Equivalent to listSubnets
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListSubnetsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.ISubnet> | {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. |
/**
* 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 be queried for
* subnets.
* 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'
/**
* The maximum number of subnets 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 `ListSubnetsRequest` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListSubnetsRequest` 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 callListSubnets() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await vmwareengineClient.listSubnetsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSubnets();
listSubnetsStream(request, options)
listSubnetsStream(request?: protos.google.cloud.vmwareengine.v1.IListSubnetsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListSubnetsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
listVmwareEngineNetworks(request, options)
listVmwareEngineNetworks(request?: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork[],
protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest | null,
protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse
]>;
Lists VmwareEngineNetwork
resources in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
IListVmwareEngineNetworksRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork[],
protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest | null,
protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listVmwareEngineNetworks(request, options, callback)
listVmwareEngineNetworks(request: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>): void;
Parameters | |
---|---|
Name | Description |
request |
IListVmwareEngineNetworksRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>
|
Returns | |
---|---|
Type | Description |
void |
listVmwareEngineNetworks(request, callback)
listVmwareEngineNetworks(request: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, callback: PaginationCallback<protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>): void;
Parameters | |
---|---|
Name | Description |
request |
IListVmwareEngineNetworksRequest
|
callback |
PaginationCallback<protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksResponse | null | undefined, protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>
|
Returns | |
---|---|
Type | Description |
void |
listVmwareEngineNetworksAsync(request, options)
listVmwareEngineNetworksAsync(request?: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork>;
Equivalent to listVmwareEngineNetworks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListVmwareEngineNetworksRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork> | {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. |
/**
* 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 query for
* VMware Engine networks. 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'
/**
* The maximum number of results to return in one page.
* 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 `ListVmwareEngineNetworks` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListVmwareEngineNetworks` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
/**
* A filter expression that matches resources returned in the response.
* The expression must specify the field name, a comparison
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The comparison operator
* must be `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" a="" list="" of="" network="" peerings,="" you="" can="" *="" exclude="" the="" ones="" named="" `example-network`="" by="" specifying="" *="" `name="" !="example-network" `.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" *="" parentheses.="" for="" example:="" *="">
* (name = "example-network")
* (createTime > "2021-04-12T08:15:10.40Z")
*
- By default, each expression is an
AND
expression. However, you - can include
AND
andOR
expressions explicitly. - For example:
- (name = "example-network-1") AND
- (createTime > "2021-04-12T08:15:10.40Z") OR
- (name = "example-network-2")
- / // const filter = 'abc123' /*
- Sorts list results by a certain order. By default, returned results
- are ordered by
name
in ascending order. - You can also sort results in descending order based on the
name
value - using
orderBy="name desc"
. Currently, only ordering by
name
is supported. */ // const orderBy = 'abc123'// Imports the Vmwareengine library const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client const vmwareengineClient = new VmwareEngineClient();
async function callListVmwareEngineNetworks() { // Construct request const request = { parent, };
// Run request const iterable = await vmwareengineClient.listVmwareEngineNetworksAsync(request); for await (const response of iterable) { console.log(response); } }
callListVmwareEngineNetworks();
listVmwareEngineNetworksStream(request, options)
listVmwareEngineNetworksStream(request?: protos.google.cloud.vmwareengine.v1.IListVmwareEngineNetworksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListVmwareEngineNetworksRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
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 |
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
loggingServerPath(project, location, privateCloud, loggingServer)
loggingServerPath(project: string, location: string, privateCloud: string, loggingServer: string): string;
Return a fully-qualified loggingServer resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
loggingServer |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
managementDnsZoneBindingPath(project, location, privateCloud, managementDnsZoneBinding)
managementDnsZoneBindingPath(project: string, location: string, privateCloud: string, managementDnsZoneBinding: string): string;
Return a fully-qualified managementDnsZoneBinding resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
managementDnsZoneBinding |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
matchClusterFromClusterName(clusterName)
matchClusterFromClusterName(clusterName: string): string | number;
Parse the cluster from Cluster resource.
Parameter | |
---|---|
Name | Description |
clusterName |
string
A fully-qualified path representing Cluster resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the cluster. |
matchClusterFromNodeName(nodeName)
matchClusterFromNodeName(nodeName: string): string | number;
Parse the cluster from Node resource.
Parameter | |
---|---|
Name | Description |
nodeName |
string
A fully-qualified path representing Node resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the cluster. |
matchExternalAccessRuleFromExternalAccessRuleName(externalAccessRuleName)
matchExternalAccessRuleFromExternalAccessRuleName(externalAccessRuleName: string): string | number;
Parse the external_access_rule from ExternalAccessRule resource.
Parameter | |
---|---|
Name | Description |
externalAccessRuleName |
string
A fully-qualified path representing ExternalAccessRule resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the external_access_rule. |
matchExternalAddressFromExternalAddressName(externalAddressName)
matchExternalAddressFromExternalAddressName(externalAddressName: string): string | number;
Parse the external_address from ExternalAddress resource.
Parameter | |
---|---|
Name | Description |
externalAddressName |
string
A fully-qualified path representing ExternalAddress resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the external_address. |
matchHcxActivationKeyFromHcxActivationKeyName(hcxActivationKeyName)
matchHcxActivationKeyFromHcxActivationKeyName(hcxActivationKeyName: string): string | number;
Parse the hcx_activation_key from HcxActivationKey resource.
Parameter | |
---|---|
Name | Description |
hcxActivationKeyName |
string
A fully-qualified path representing HcxActivationKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the hcx_activation_key. |
matchLocationFromClusterName(clusterName)
matchLocationFromClusterName(clusterName: string): string | number;
Parse the location from Cluster resource.
Parameter | |
---|---|
Name | Description |
clusterName |
string
A fully-qualified path representing Cluster resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromDnsBindPermissionName(dnsBindPermissionName)
matchLocationFromDnsBindPermissionName(dnsBindPermissionName: string): string | number;
Parse the location from DnsBindPermission resource.
Parameter | |
---|---|
Name | Description |
dnsBindPermissionName |
string
A fully-qualified path representing DnsBindPermission resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromDnsForwardingName(dnsForwardingName)
matchLocationFromDnsForwardingName(dnsForwardingName: string): string | number;
Parse the location from DnsForwarding resource.
Parameter | |
---|---|
Name | Description |
dnsForwardingName |
string
A fully-qualified path representing DnsForwarding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromExternalAccessRuleName(externalAccessRuleName)
matchLocationFromExternalAccessRuleName(externalAccessRuleName: string): string | number;
Parse the location from ExternalAccessRule resource.
Parameter | |
---|---|
Name | Description |
externalAccessRuleName |
string
A fully-qualified path representing ExternalAccessRule resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromExternalAddressName(externalAddressName)
matchLocationFromExternalAddressName(externalAddressName: string): string | number;
Parse the location from ExternalAddress resource.
Parameter | |
---|---|
Name | Description |
externalAddressName |
string
A fully-qualified path representing ExternalAddress resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromHcxActivationKeyName(hcxActivationKeyName)
matchLocationFromHcxActivationKeyName(hcxActivationKeyName: string): string | number;
Parse the location from HcxActivationKey resource.
Parameter | |
---|---|
Name | Description |
hcxActivationKeyName |
string
A fully-qualified path representing HcxActivationKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter | |
---|---|
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromLoggingServerName(loggingServerName)
matchLocationFromLoggingServerName(loggingServerName: string): string | number;
Parse the location from LoggingServer resource.
Parameter | |
---|---|
Name | Description |
loggingServerName |
string
A fully-qualified path representing LoggingServer resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromManagementDnsZoneBindingName(managementDnsZoneBindingName)
matchLocationFromManagementDnsZoneBindingName(managementDnsZoneBindingName: string): string | number;
Parse the location from ManagementDnsZoneBinding resource.
Parameter | |
---|---|
Name | Description |
managementDnsZoneBindingName |
string
A fully-qualified path representing ManagementDnsZoneBinding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromNetworkPeeringName(networkPeeringName)
matchLocationFromNetworkPeeringName(networkPeeringName: string): string | number;
Parse the location from NetworkPeering resource.
Parameter | |
---|---|
Name | Description |
networkPeeringName |
string
A fully-qualified path representing NetworkPeering resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromNetworkPolicyName(networkPolicyName)
matchLocationFromNetworkPolicyName(networkPolicyName: string): string | number;
Parse the location from NetworkPolicy resource.
Parameter | |
---|---|
Name | Description |
networkPolicyName |
string
A fully-qualified path representing NetworkPolicy resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromNodeName(nodeName)
matchLocationFromNodeName(nodeName: string): string | number;
Parse the location from Node resource.
Parameter | |
---|---|
Name | Description |
nodeName |
string
A fully-qualified path representing Node resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromNodeTypeName(nodeTypeName)
matchLocationFromNodeTypeName(nodeTypeName: string): string | number;
Parse the location from NodeType resource.
Parameter | |
---|---|
Name | Description |
nodeTypeName |
string
A fully-qualified path representing NodeType resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromPrivateCloudName(privateCloudName)
matchLocationFromPrivateCloudName(privateCloudName: string): string | number;
Parse the location from PrivateCloud resource.
Parameter | |
---|---|
Name | Description |
privateCloudName |
string
A fully-qualified path representing PrivateCloud resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromPrivateConnectionName(privateConnectionName)
matchLocationFromPrivateConnectionName(privateConnectionName: string): string | number;
Parse the location from PrivateConnection resource.
Parameter | |
---|---|
Name | Description |
privateConnectionName |
string
A fully-qualified path representing PrivateConnection resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromSubnetName(subnetName)
matchLocationFromSubnetName(subnetName: string): string | number;
Parse the location from Subnet resource.
Parameter | |
---|---|
Name | Description |
subnetName |
string
A fully-qualified path representing Subnet resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromVmwareEngineNetworkName(vmwareEngineNetworkName)
matchLocationFromVmwareEngineNetworkName(vmwareEngineNetworkName: string): string | number;
Parse the location from VmwareEngineNetwork resource.
Parameter | |
---|---|
Name | Description |
vmwareEngineNetworkName |
string
A fully-qualified path representing VmwareEngineNetwork resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLoggingServerFromLoggingServerName(loggingServerName)
matchLoggingServerFromLoggingServerName(loggingServerName: string): string | number;
Parse the logging_server from LoggingServer resource.
Parameter | |
---|---|
Name | Description |
loggingServerName |
string
A fully-qualified path representing LoggingServer resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the logging_server. |
matchManagementDnsZoneBindingFromManagementDnsZoneBindingName(managementDnsZoneBindingName)
matchManagementDnsZoneBindingFromManagementDnsZoneBindingName(managementDnsZoneBindingName: string): string | number;
Parse the management_dns_zone_binding from ManagementDnsZoneBinding resource.
Parameter | |
---|---|
Name | Description |
managementDnsZoneBindingName |
string
A fully-qualified path representing ManagementDnsZoneBinding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the management_dns_zone_binding. |
matchNetworkPeeringFromNetworkPeeringName(networkPeeringName)
matchNetworkPeeringFromNetworkPeeringName(networkPeeringName: string): string | number;
Parse the network_peering from NetworkPeering resource.
Parameter | |
---|---|
Name | Description |
networkPeeringName |
string
A fully-qualified path representing NetworkPeering resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the network_peering. |
matchNetworkPolicyFromExternalAccessRuleName(externalAccessRuleName)
matchNetworkPolicyFromExternalAccessRuleName(externalAccessRuleName: string): string | number;
Parse the network_policy from ExternalAccessRule resource.
Parameter | |
---|---|
Name | Description |
externalAccessRuleName |
string
A fully-qualified path representing ExternalAccessRule resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the network_policy. |
matchNetworkPolicyFromNetworkPolicyName(networkPolicyName)
matchNetworkPolicyFromNetworkPolicyName(networkPolicyName: string): string | number;
Parse the network_policy from NetworkPolicy resource.
Parameter | |
---|---|
Name | Description |
networkPolicyName |
string
A fully-qualified path representing NetworkPolicy resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the network_policy. |
matchNodeFromNodeName(nodeName)
matchNodeFromNodeName(nodeName: string): string | number;
Parse the node from Node resource.
Parameter | |
---|---|
Name | Description |
nodeName |
string
A fully-qualified path representing Node resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the node. |
matchNodeTypeFromNodeTypeName(nodeTypeName)
matchNodeTypeFromNodeTypeName(nodeTypeName: string): string | number;
Parse the node_type from NodeType resource.
Parameter | |
---|---|
Name | Description |
nodeTypeName |
string
A fully-qualified path representing NodeType resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the node_type. |
matchPrivateCloudFromClusterName(clusterName)
matchPrivateCloudFromClusterName(clusterName: string): string | number;
Parse the private_cloud from Cluster resource.
Parameter | |
---|---|
Name | Description |
clusterName |
string
A fully-qualified path representing Cluster resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateCloudFromDnsForwardingName(dnsForwardingName)
matchPrivateCloudFromDnsForwardingName(dnsForwardingName: string): string | number;
Parse the private_cloud from DnsForwarding resource.
Parameter | |
---|---|
Name | Description |
dnsForwardingName |
string
A fully-qualified path representing DnsForwarding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateCloudFromExternalAddressName(externalAddressName)
matchPrivateCloudFromExternalAddressName(externalAddressName: string): string | number;
Parse the private_cloud from ExternalAddress resource.
Parameter | |
---|---|
Name | Description |
externalAddressName |
string
A fully-qualified path representing ExternalAddress resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateCloudFromHcxActivationKeyName(hcxActivationKeyName)
matchPrivateCloudFromHcxActivationKeyName(hcxActivationKeyName: string): string | number;
Parse the private_cloud from HcxActivationKey resource.
Parameter | |
---|---|
Name | Description |
hcxActivationKeyName |
string
A fully-qualified path representing HcxActivationKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateCloudFromLoggingServerName(loggingServerName)
matchPrivateCloudFromLoggingServerName(loggingServerName: string): string | number;
Parse the private_cloud from LoggingServer resource.
Parameter | |
---|---|
Name | Description |
loggingServerName |
string
A fully-qualified path representing LoggingServer resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateCloudFromManagementDnsZoneBindingName(managementDnsZoneBindingName)
matchPrivateCloudFromManagementDnsZoneBindingName(managementDnsZoneBindingName: string): string | number;
Parse the private_cloud from ManagementDnsZoneBinding resource.
Parameter | |
---|---|
Name | Description |
managementDnsZoneBindingName |
string
A fully-qualified path representing ManagementDnsZoneBinding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateCloudFromNodeName(nodeName)
matchPrivateCloudFromNodeName(nodeName: string): string | number;
Parse the private_cloud from Node resource.
Parameter | |
---|---|
Name | Description |
nodeName |
string
A fully-qualified path representing Node resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateCloudFromPrivateCloudName(privateCloudName)
matchPrivateCloudFromPrivateCloudName(privateCloudName: string): string | number;
Parse the private_cloud from PrivateCloud resource.
Parameter | |
---|---|
Name | Description |
privateCloudName |
string
A fully-qualified path representing PrivateCloud resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateCloudFromSubnetName(subnetName)
matchPrivateCloudFromSubnetName(subnetName: string): string | number;
Parse the private_cloud from Subnet resource.
Parameter | |
---|---|
Name | Description |
subnetName |
string
A fully-qualified path representing Subnet resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_cloud. |
matchPrivateConnectionFromPrivateConnectionName(privateConnectionName)
matchPrivateConnectionFromPrivateConnectionName(privateConnectionName: string): string | number;
Parse the private_connection from PrivateConnection resource.
Parameter | |
---|---|
Name | Description |
privateConnectionName |
string
A fully-qualified path representing PrivateConnection resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the private_connection. |
matchProjectFromClusterName(clusterName)
matchProjectFromClusterName(clusterName: string): string | number;
Parse the project from Cluster resource.
Parameter | |
---|---|
Name | Description |
clusterName |
string
A fully-qualified path representing Cluster resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromDnsBindPermissionName(dnsBindPermissionName)
matchProjectFromDnsBindPermissionName(dnsBindPermissionName: string): string | number;
Parse the project from DnsBindPermission resource.
Parameter | |
---|---|
Name | Description |
dnsBindPermissionName |
string
A fully-qualified path representing DnsBindPermission resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromDnsForwardingName(dnsForwardingName)
matchProjectFromDnsForwardingName(dnsForwardingName: string): string | number;
Parse the project from DnsForwarding resource.
Parameter | |
---|---|
Name | Description |
dnsForwardingName |
string
A fully-qualified path representing DnsForwarding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromExternalAccessRuleName(externalAccessRuleName)
matchProjectFromExternalAccessRuleName(externalAccessRuleName: string): string | number;
Parse the project from ExternalAccessRule resource.
Parameter | |
---|---|
Name | Description |
externalAccessRuleName |
string
A fully-qualified path representing ExternalAccessRule resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromExternalAddressName(externalAddressName)
matchProjectFromExternalAddressName(externalAddressName: string): string | number;
Parse the project from ExternalAddress resource.
Parameter | |
---|---|
Name | Description |
externalAddressName |
string
A fully-qualified path representing ExternalAddress resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromHcxActivationKeyName(hcxActivationKeyName)
matchProjectFromHcxActivationKeyName(hcxActivationKeyName: string): string | number;
Parse the project from HcxActivationKey resource.
Parameter | |
---|---|
Name | Description |
hcxActivationKeyName |
string
A fully-qualified path representing HcxActivationKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter | |
---|---|
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromLoggingServerName(loggingServerName)
matchProjectFromLoggingServerName(loggingServerName: string): string | number;
Parse the project from LoggingServer resource.
Parameter | |
---|---|
Name | Description |
loggingServerName |
string
A fully-qualified path representing LoggingServer resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromManagementDnsZoneBindingName(managementDnsZoneBindingName)
matchProjectFromManagementDnsZoneBindingName(managementDnsZoneBindingName: string): string | number;
Parse the project from ManagementDnsZoneBinding resource.
Parameter | |
---|---|
Name | Description |
managementDnsZoneBindingName |
string
A fully-qualified path representing ManagementDnsZoneBinding resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromNetworkPeeringName(networkPeeringName)
matchProjectFromNetworkPeeringName(networkPeeringName: string): string | number;
Parse the project from NetworkPeering resource.
Parameter | |
---|---|
Name | Description |
networkPeeringName |
string
A fully-qualified path representing NetworkPeering resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromNetworkPolicyName(networkPolicyName)
matchProjectFromNetworkPolicyName(networkPolicyName: string): string | number;
Parse the project from NetworkPolicy resource.
Parameter | |
---|---|
Name | Description |
networkPolicyName |
string
A fully-qualified path representing NetworkPolicy resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromNodeName(nodeName)
matchProjectFromNodeName(nodeName: string): string | number;
Parse the project from Node resource.
Parameter | |
---|---|
Name | Description |
nodeName |
string
A fully-qualified path representing Node resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromNodeTypeName(nodeTypeName)
matchProjectFromNodeTypeName(nodeTypeName: string): string | number;
Parse the project from NodeType resource.
Parameter | |
---|---|
Name | Description |
nodeTypeName |
string
A fully-qualified path representing NodeType resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromPrivateCloudName(privateCloudName)
matchProjectFromPrivateCloudName(privateCloudName: string): string | number;
Parse the project from PrivateCloud resource.
Parameter | |
---|---|
Name | Description |
privateCloudName |
string
A fully-qualified path representing PrivateCloud resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromPrivateConnectionName(privateConnectionName)
matchProjectFromPrivateConnectionName(privateConnectionName: string): string | number;
Parse the project from PrivateConnection resource.
Parameter | |
---|---|
Name | Description |
privateConnectionName |
string
A fully-qualified path representing PrivateConnection resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Parameter | |
---|---|
Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromSubnetName(subnetName)
matchProjectFromSubnetName(subnetName: string): string | number;
Parse the project from Subnet resource.
Parameter | |
---|---|
Name | Description |
subnetName |
string
A fully-qualified path representing Subnet resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromVmwareEngineNetworkName(vmwareEngineNetworkName)
matchProjectFromVmwareEngineNetworkName(vmwareEngineNetworkName: string): string | number;
Parse the project from VmwareEngineNetwork resource.
Parameter | |
---|---|
Name | Description |
vmwareEngineNetworkName |
string
A fully-qualified path representing VmwareEngineNetwork resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchSubnetFromSubnetName(subnetName)
matchSubnetFromSubnetName(subnetName: string): string | number;
Parse the subnet from Subnet resource.
Parameter | |
---|---|
Name | Description |
subnetName |
string
A fully-qualified path representing Subnet resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the subnet. |
matchVmwareEngineNetworkFromVmwareEngineNetworkName(vmwareEngineNetworkName)
matchVmwareEngineNetworkFromVmwareEngineNetworkName(vmwareEngineNetworkName: string): string | number;
Parse the vmware_engine_network from VmwareEngineNetwork resource.
Parameter | |
---|---|
Name | Description |
vmwareEngineNetworkName |
string
A fully-qualified path representing VmwareEngineNetwork resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the vmware_engine_network. |
networkPeeringPath(project, location, networkPeering)
networkPeeringPath(project: string, location: string, networkPeering: string): string;
Return a fully-qualified networkPeering resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
networkPeering |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
networkPolicyPath(project, location, networkPolicy)
networkPolicyPath(project: string, location: string, networkPolicy: string): string;
Return a fully-qualified networkPolicy resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
networkPolicy |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
nodePath(project, location, privateCloud, cluster, node)
nodePath(project: string, location: string, privateCloud: string, cluster: string, node: string): string;
Return a fully-qualified node resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
cluster |
string
|
node |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
nodeTypePath(project, location, nodeType)
nodeTypePath(project: string, location: string, nodeType: string): string;
Return a fully-qualified nodeType resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
nodeType |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
privateCloudPath(project, location, privateCloud)
privateCloudPath(project: string, location: string, privateCloud: string): string;
Return a fully-qualified privateCloud resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
privateConnectionPath(project, location, privateConnection)
privateConnectionPath(project: string, location: string, privateConnection: string): string;
Return a fully-qualified privateConnection resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
privateConnection |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
repairManagementDnsZoneBinding(request, options)
repairManagementDnsZoneBinding(request?: protos.google.cloud.vmwareengine.v1.IRepairManagementDnsZoneBindingRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Retries to create a ManagementDnsZoneBinding
resource that is in failed state.
Parameters | |
---|---|
Name | Description |
request |
IRepairManagementDnsZoneBindingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
repairManagementDnsZoneBinding(request, options, callback)
repairManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.IRepairManagementDnsZoneBindingRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IRepairManagementDnsZoneBindingRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
repairManagementDnsZoneBinding(request, callback)
repairManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.IRepairManagementDnsZoneBindingRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRepairManagementDnsZoneBindingRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
resetNsxCredentials(request, options)
resetNsxCredentials(request?: protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Resets credentials of the NSX appliance.
Parameters | |
---|---|
Name | Description |
request |
IResetNsxCredentialsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
resetNsxCredentials(request, options, callback)
resetNsxCredentials(request: protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IResetNsxCredentialsRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
resetNsxCredentials(request, callback)
resetNsxCredentials(request: protos.google.cloud.vmwareengine.v1.IResetNsxCredentialsRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IResetNsxCredentialsRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
resetVcenterCredentials(request, options)
resetVcenterCredentials(request?: protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Resets credentials of the Vcenter appliance.
Parameters | |
---|---|
Name | Description |
request |
IResetVcenterCredentialsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
resetVcenterCredentials(request, options, callback)
resetVcenterCredentials(request: protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IResetVcenterCredentialsRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
resetVcenterCredentials(request, callback)
resetVcenterCredentials(request: protos.google.cloud.vmwareengine.v1.IResetVcenterCredentialsRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IResetVcenterCredentialsRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
revokeDnsBindPermission(request, options)
revokeDnsBindPermission(request?: protos.google.cloud.vmwareengine.v1.IRevokeDnsBindPermissionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Revokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project. DnsBindPermission is a global resource and location can only be global.
Parameters | |
---|---|
Name | Description |
request |
IRevokeDnsBindPermissionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
revokeDnsBindPermission(request, options, callback)
revokeDnsBindPermission(request: protos.google.cloud.vmwareengine.v1.IRevokeDnsBindPermissionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRevokeDnsBindPermissionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
revokeDnsBindPermission(request, callback)
revokeDnsBindPermission(request: protos.google.cloud.vmwareengine.v1.IRevokeDnsBindPermissionRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRevokeDnsBindPermissionRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsBindPermission, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setIamPolicy(request, options, callback)
setIamPolicy(request: IamProtos.google.iam.v1.SetIamPolicyRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.Policy, IamProtos.google.iam.v1.SetIamPolicyRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.Policy]>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
IamProtos.google.iam.v1.SetIamPolicyRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.iam.v1.Policy, google.iam.v1.SetIamPolicyRequest | 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.SetIamPolicyRequest | 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. |
showNsxCredentials(request, options)
showNsxCredentials(request?: protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.ICredentials,
(protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | undefined),
{} | undefined
]>;
Gets details of credentials for NSX appliance.
Parameters | |
---|---|
Name | Description |
request |
IShowNsxCredentialsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.ICredentials,
(protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Credentials. Please see the documentation for more details and examples. |
/**
* 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 be queried for credentials.
* 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'
// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;
// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();
async function callShowNsxCredentials() {
// Construct request
const request = {
privateCloud,
};
// Run request
const response = await vmwareengineClient.showNsxCredentials(request);
console.log(response);
}
callShowNsxCredentials();
showNsxCredentials(request, options, callback)
showNsxCredentials(request: protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IShowNsxCredentialsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
showNsxCredentials(request, callback)
showNsxCredentials(request: protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IShowNsxCredentialsRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowNsxCredentialsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
showVcenterCredentials(request, options)
showVcenterCredentials(request?: protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest, options?: CallOptions): Promise<[
protos.google.cloud.vmwareengine.v1.ICredentials,
(protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | undefined),
{} | undefined
]>;
Gets details of credentials for Vcenter appliance.
Parameters | |
---|---|
Name | Description |
request |
IShowVcenterCredentialsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.vmwareengine.v1.ICredentials,
(protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing Credentials. Please see the documentation for more details and examples. |
/**
* 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 be queried for credentials.
* 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. The username of the user to be queried for credentials.
* The default value of this field is CloudOwner@gve.local.
* The provided value must be one of the following:
* CloudOwner@gve.local,
* 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 callShowVcenterCredentials() {
// Construct request
const request = {
privateCloud,
};
// Run request
const response = await vmwareengineClient.showVcenterCredentials(request);
console.log(response);
}
callShowVcenterCredentials();
showVcenterCredentials(request, options, callback)
showVcenterCredentials(request: protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest, options: CallOptions, callback: Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IShowVcenterCredentialsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
showVcenterCredentials(request, callback)
showVcenterCredentials(request: protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest, callback: Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IShowVcenterCredentialsRequest
|
callback |
Callback<protos.google.cloud.vmwareengine.v1.ICredentials, protos.google.cloud.vmwareengine.v1.IShowVcenterCredentialsRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
subnetPath(project, location, privateCloud, subnet)
subnetPath(project: string, location: string, privateCloud: string, subnet: string): string;
Return a fully-qualified subnet resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
privateCloud |
string
|
subnet |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
testIamPermissions(request, options, callback)
testIamPermissions(request: IamProtos.google.iam.v1.TestIamPermissionsRequest, options?: gax.CallOptions | Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>, callback?: Callback<IamProtos.google.iam.v1.TestIamPermissionsResponse, IamProtos.google.iam.v1.TestIamPermissionsRequest | null | undefined, {} | null | undefined>): Promise<[IamProtos.google.iam.v1.TestIamPermissionsResponse]>;
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
request |
IamProtos.google.iam.v1.TestIamPermissionsRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.iam.v1.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | 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.TestIamPermissionsResponse, google.iam.v1.TestIamPermissionsRequest | 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.TestIamPermissionsResponse]> | {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. |
undeletePrivateCloud(request, options)
undeletePrivateCloud(request?: protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud
. A PrivateCloud
resource scheduled for deletion has PrivateCloud.state
set to DELETED
and PrivateCloud.expireTime
set to the time when deletion can no longer be reversed.
Parameters | |
---|---|
Name | Description |
request |
IUndeletePrivateCloudRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
undeletePrivateCloud(request, options, callback)
undeletePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUndeletePrivateCloudRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
undeletePrivateCloud(request, callback)
undeletePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IUndeletePrivateCloudRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUndeletePrivateCloudRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateCluster(request, options)
updateCluster(request?: protos.google.cloud.vmwareengine.v1.IUpdateClusterRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Modifies a Cluster
resource. Only fields specified in updateMask
are applied.
During operation processing, the resource is temporarily in the ACTIVE
state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
Parameters | |
---|---|
Name | Description |
request |
IUpdateClusterRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateCluster(request, options, callback)
updateCluster(request: protos.google.cloud.vmwareengine.v1.IUpdateClusterRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdateClusterRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updateCluster(request, callback)
updateCluster(request: protos.google.cloud.vmwareengine.v1.IUpdateClusterRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateClusterRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.ICluster, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateDnsForwarding(request, options)
updateDnsForwarding(request?: protos.google.cloud.vmwareengine.v1.IUpdateDnsForwardingRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates the parameters of the DnsForwarding
config, like associated domains. Only fields specified in update_mask
are applied.
Parameters | |
---|---|
Name | Description |
request |
IUpdateDnsForwardingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateDnsForwarding(request, options, callback)
updateDnsForwarding(request: protos.google.cloud.vmwareengine.v1.IUpdateDnsForwardingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateDnsForwardingRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateDnsForwarding(request, callback)
updateDnsForwarding(request: protos.google.cloud.vmwareengine.v1.IUpdateDnsForwardingRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateDnsForwardingRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IDnsForwarding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateExternalAccessRule(request, options)
updateExternalAccessRule(request?: protos.google.cloud.vmwareengine.v1.IUpdateExternalAccessRuleRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates the parameters of a single external access rule. Only fields specified in update_mask
are applied.
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalAccessRuleRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateExternalAccessRule(request, options, callback)
updateExternalAccessRule(request: protos.google.cloud.vmwareengine.v1.IUpdateExternalAccessRuleRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalAccessRuleRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updateExternalAccessRule(request, callback)
updateExternalAccessRule(request: protos.google.cloud.vmwareengine.v1.IUpdateExternalAccessRuleRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalAccessRuleRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAccessRule, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateExternalAddress(request, options)
updateExternalAddress(request?: protos.google.cloud.vmwareengine.v1.IUpdateExternalAddressRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates the parameters of a single external IP address. Only fields specified in update_mask
are applied.
During operation processing, the resource is temporarily in the ACTIVE
state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalAddressRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateExternalAddress(request, options, callback)
updateExternalAddress(request: protos.google.cloud.vmwareengine.v1.IUpdateExternalAddressRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalAddressRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updateExternalAddress(request, callback)
updateExternalAddress(request: protos.google.cloud.vmwareengine.v1.IUpdateExternalAddressRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateExternalAddressRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IExternalAddress, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateLoggingServer(request, options)
updateLoggingServer(request?: protos.google.cloud.vmwareengine.v1.IUpdateLoggingServerRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates the parameters of a single logging server. Only fields specified in update_mask
are applied.
Parameters | |
---|---|
Name | Description |
request |
IUpdateLoggingServerRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateLoggingServer(request, options, callback)
updateLoggingServer(request: protos.google.cloud.vmwareengine.v1.IUpdateLoggingServerRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdateLoggingServerRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updateLoggingServer(request, callback)
updateLoggingServer(request: protos.google.cloud.vmwareengine.v1.IUpdateLoggingServerRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateLoggingServerRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.ILoggingServer, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateManagementDnsZoneBinding(request, options)
updateManagementDnsZoneBinding(request?: protos.google.cloud.vmwareengine.v1.IUpdateManagementDnsZoneBindingRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates a ManagementDnsZoneBinding
resource. Only fields specified in update_mask
are applied.
Parameters | |
---|---|
Name | Description |
request |
IUpdateManagementDnsZoneBindingRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateManagementDnsZoneBinding(request, options, callback)
updateManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.IUpdateManagementDnsZoneBindingRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdateManagementDnsZoneBindingRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updateManagementDnsZoneBinding(request, callback)
updateManagementDnsZoneBinding(request: protos.google.cloud.vmwareengine.v1.IUpdateManagementDnsZoneBindingRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateManagementDnsZoneBindingRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IManagementDnsZoneBinding, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateNetworkPeering(request, options)
updateNetworkPeering(request?: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPeeringRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Modifies a NetworkPeering
resource. Only the description
field can be updated. Only fields specified in updateMask
are applied. NetworkPeering is a global resource and location can only be global.
Parameters | |
---|---|
Name | Description |
request |
IUpdateNetworkPeeringRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateNetworkPeering(request, options, callback)
updateNetworkPeering(request: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPeeringRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdateNetworkPeeringRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updateNetworkPeering(request, callback)
updateNetworkPeering(request: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPeeringRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateNetworkPeeringRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPeering, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateNetworkPolicy(request, options)
updateNetworkPolicy(request?: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Modifies a NetworkPolicy
resource. Only the following fields can be updated: internet_access
, external_ip
, edge_services_cidr
. Only fields specified in updateMask
are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a NetworkService
cannot be updated when NetworkService.state
is set to RECONCILING
.
During operation processing, the resource is temporarily in the ACTIVE
state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
Parameters | |
---|---|
Name | Description |
request |
IUpdateNetworkPolicyRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateNetworkPolicy(request, options, callback)
updateNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdateNetworkPolicyRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updateNetworkPolicy(request, callback)
updateNetworkPolicy(request: protos.google.cloud.vmwareengine.v1.IUpdateNetworkPolicyRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateNetworkPolicyRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.INetworkPolicy, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updatePrivateCloud(request, options)
updatePrivateCloud(request?: protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Modifies a PrivateCloud
resource. Only the following fields can be updated: description
. Only fields specified in updateMask
are applied.
During operation processing, the resource is temporarily in the ACTIVE
state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
Parameters | |
---|---|
Name | Description |
request |
IUpdatePrivateCloudRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updatePrivateCloud(request, options, callback)
updatePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdatePrivateCloudRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updatePrivateCloud(request, callback)
updatePrivateCloud(request: protos.google.cloud.vmwareengine.v1.IUpdatePrivateCloudRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdatePrivateCloudRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateCloud, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updatePrivateConnection(request, options)
updatePrivateConnection(request?: protos.google.cloud.vmwareengine.v1.IUpdatePrivateConnectionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Modifies a PrivateConnection
resource. Only description
and routing_mode
fields can be updated. Only fields specified in updateMask
are applied.
Parameters | |
---|---|
Name | Description |
request |
IUpdatePrivateConnectionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updatePrivateConnection(request, options, callback)
updatePrivateConnection(request: protos.google.cloud.vmwareengine.v1.IUpdatePrivateConnectionRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdatePrivateConnectionRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updatePrivateConnection(request, callback)
updatePrivateConnection(request: protos.google.cloud.vmwareengine.v1.IUpdatePrivateConnectionRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdatePrivateConnectionRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IPrivateConnection, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateSubnet(request, options)
updateSubnet(request?: protos.google.cloud.vmwareengine.v1.IUpdateSubnetRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates the parameters of a single subnet. Only fields specified in update_mask
are applied.
*Note*: This API is synchronous and always returns a successful google.longrunning.Operation
(LRO). The returned LRO will only have done
and response
fields.
Parameters | |
---|---|
Name | Description |
request |
IUpdateSubnetRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateSubnet(request, options, callback)
updateSubnet(request: protos.google.cloud.vmwareengine.v1.IUpdateSubnetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateSubnetRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateSubnet(request, callback)
updateSubnet(request: protos.google.cloud.vmwareengine.v1.IUpdateSubnetRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateSubnetRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.ISubnet, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateVmwareEngineNetwork(request, options)
updateVmwareEngineNetwork(request?: protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Modifies a VMware Engine network resource. Only the following fields can be updated: description
. Only fields specified in updateMask
are applied.
Parameters | |
---|---|
Name | Description |
request |
IUpdateVmwareEngineNetworkRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
updateVmwareEngineNetwork(request, options, callback)
updateVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest, 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;
Parameters | |
---|---|
Name | Description |
request |
IUpdateVmwareEngineNetworkRequest
|
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>
|
Returns | |
---|---|
Type | Description |
void |
updateVmwareEngineNetwork(request, callback)
updateVmwareEngineNetwork(request: protos.google.cloud.vmwareengine.v1.IUpdateVmwareEngineNetworkRequest, callback: Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateVmwareEngineNetworkRequest
|
callback |
Callback<LROperation<protos.google.cloud.vmwareengine.v1.IVmwareEngineNetwork, protos.google.cloud.vmwareengine.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
vmwareEngineNetworkPath(project, location, vmwareEngineNetwork)
vmwareEngineNetworkPath(project: string, location: string, vmwareEngineNetwork: string): string;
Return a fully-qualified vmwareEngineNetwork resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
vmwareEngineNetwork |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |