Struct VmwareEngine

pub struct VmwareEngine { /* private fields */ }

Implements a client for the VMware Engine API.

Service Description

VMwareEngine manages VMware’s private clusters in the Cloud.

Configuration

VmwareEngine has various configuration parameters, the defaults should work with most applications.

Pooling and Cloning

VmwareEngine holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap VmwareEngine in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl VmwareEngine

pub async fn new() -> Result<Self>

Creates a new client with the default configuration.

pub async fn new_with_config(conf: ClientConfig) -> Result<Self>

Creates a new client with the specified configuration.

pub fn from_stub<T>(stub: T) -> Self

where T: VmwareEngine + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is when mocking the client.

pub fn list_private_clouds( &self, parent: impl Into<String>, ) -> ListPrivateClouds

Lists PrivateCloud resources in a given project and location.

pub fn get_private_cloud(&self, name: impl Into<String>) -> GetPrivateCloud

Retrieves a PrivateCloud resource by its resource name.

pub fn create_private_cloud( &self, parent: impl Into<String>, ) -> CreatePrivateCloud

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 for that private cloud.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_private_cloud( &self, private_cloud: impl Into<PrivateCloud>, ) -> UpdatePrivateCloud

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_private_cloud( &self, name: impl Into<String>, ) -> DeletePrivateCloud

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn undelete_private_cloud( &self, name: impl Into<String>, ) -> UndeletePrivateCloud

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_clusters(&self, parent: impl Into<String>) -> ListClusters

Lists Cluster resources in a given private cloud.

pub fn get_cluster(&self, name: impl Into<String>) -> GetCluster

Retrieves a Cluster resource by its resource name.

pub fn create_cluster(&self, parent: impl Into<String>) -> CreateCluster

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_cluster(&self, cluster: impl Into<Cluster>) -> UpdateCluster

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_cluster(&self, name: impl Into<String>) -> DeleteCluster

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_nodes(&self, parent: impl Into<String>) -> ListNodes

Lists nodes in a given cluster.

pub fn get_node(&self, name: impl Into<String>) -> GetNode

Gets details of a single node.

pub fn list_external_addresses( &self, parent: impl Into<String>, ) -> ListExternalAddresses

Lists external IP addresses assigned to VMware workload VMs in a given private cloud.

pub fn fetch_network_policy_external_addresses( &self, network_policy: impl Into<String>, ) -> FetchNetworkPolicyExternalAddresses

Lists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.

pub fn get_external_address( &self, name: impl Into<String>, ) -> GetExternalAddress

Gets details of a single external IP address.

pub fn create_external_address( &self, parent: impl Into<String>, ) -> CreateExternalAddress

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

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_external_address( &self, external_address: impl Into<ExternalAddress>, ) -> UpdateExternalAddress

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_external_address( &self, name: impl Into<String>, ) -> DeleteExternalAddress

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_subnets(&self, parent: impl Into<String>) -> ListSubnets

Lists subnets in a given private cloud.

pub fn get_subnet(&self, name: impl Into<String>) -> GetSubnet

Gets details of a single subnet.

pub fn update_subnet(&self, subnet: impl Into<Subnet>) -> UpdateSubnet

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_external_access_rules( &self, parent: impl Into<String>, ) -> ListExternalAccessRules

Lists ExternalAccessRule resources in the specified network policy.

pub fn get_external_access_rule( &self, name: impl Into<String>, ) -> GetExternalAccessRule

Gets details of a single external access rule.

pub fn create_external_access_rule( &self, parent: impl Into<String>, ) -> CreateExternalAccessRule

Creates a new external access rule in a given network policy.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_external_access_rule( &self, external_access_rule: impl Into<ExternalAccessRule>, ) -> UpdateExternalAccessRule

Updates the parameters of a single external access rule. Only fields specified in update_mask are applied.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_external_access_rule( &self, name: impl Into<String>, ) -> DeleteExternalAccessRule

Deletes a single external access rule.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_logging_servers( &self, parent: impl Into<String>, ) -> ListLoggingServers

Lists logging servers configured for a given private cloud.

pub fn get_logging_server(&self, name: impl Into<String>) -> GetLoggingServer

Gets details of a logging server.

pub fn create_logging_server( &self, parent: impl Into<String>, ) -> CreateLoggingServer

Create a new logging server for a given private cloud.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_logging_server( &self, logging_server: impl Into<LoggingServer>, ) -> UpdateLoggingServer

Updates the parameters of a single logging server. Only fields specified in update_mask are applied.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_logging_server( &self, name: impl Into<String>, ) -> DeleteLoggingServer

Deletes a single logging server.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_node_types(&self, parent: impl Into<String>) -> ListNodeTypes

Lists node types

pub fn get_node_type(&self, name: impl Into<String>) -> GetNodeType

Gets details of a single NodeType.

pub fn show_nsx_credentials( &self, private_cloud: impl Into<String>, ) -> ShowNsxCredentials

Gets details of credentials for NSX appliance.

pub fn show_vcenter_credentials( &self, private_cloud: impl Into<String>, ) -> ShowVcenterCredentials

Gets details of credentials for Vcenter appliance.

pub fn reset_nsx_credentials( &self, private_cloud: impl Into<String>, ) -> ResetNsxCredentials

Resets credentials of the NSX appliance.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn reset_vcenter_credentials( &self, private_cloud: impl Into<String>, ) -> ResetVcenterCredentials

Resets credentials of the Vcenter appliance.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_dns_forwarding(&self, name: impl Into<String>) -> GetDnsForwarding

Gets details of the DnsForwarding config.

pub fn update_dns_forwarding( &self, dns_forwarding: impl Into<DnsForwarding>, ) -> UpdateDnsForwarding

Updates the parameters of the DnsForwarding config, like associated domains. Only fields specified in update_mask are applied.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_network_peering(&self, name: impl Into<String>) -> GetNetworkPeering

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.

pub fn list_network_peerings( &self, parent: impl Into<String>, ) -> ListNetworkPeerings

Lists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global.

pub fn create_network_peering( &self, parent: impl Into<String>, ) -> CreateNetworkPeering

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_network_peering( &self, name: impl Into<String>, ) -> DeleteNetworkPeering

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_network_peering( &self, network_peering: impl Into<NetworkPeering>, ) -> UpdateNetworkPeering

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_peering_routes( &self, parent: impl Into<String>, ) -> ListPeeringRoutes

Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.

pub fn create_hcx_activation_key( &self, parent: impl Into<String>, ) -> CreateHcxActivationKey

Creates a new HCX activation key in a given private cloud.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_hcx_activation_keys( &self, parent: impl Into<String>, ) -> ListHcxActivationKeys

Lists HcxActivationKey resources in a given private cloud.

pub fn get_hcx_activation_key( &self, name: impl Into<String>, ) -> GetHcxActivationKey

Retrieves a HcxActivationKey resource by its resource name.

pub fn get_network_policy(&self, name: impl Into<String>) -> GetNetworkPolicy

Retrieves a NetworkPolicy resource by its resource name.

pub fn list_network_policies( &self, parent: impl Into<String>, ) -> ListNetworkPolicies

Lists NetworkPolicy resources in a specified project and location.

pub fn create_network_policy( &self, parent: impl Into<String>, ) -> CreateNetworkPolicy

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_network_policy( &self, network_policy: impl Into<NetworkPolicy>, ) -> UpdateNetworkPolicy

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_network_policy( &self, name: impl Into<String>, ) -> DeleteNetworkPolicy

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_management_dns_zone_bindings( &self, parent: impl Into<String>, ) -> ListManagementDnsZoneBindings

Lists Consumer VPCs bound to Management DNS Zone of a given private cloud.

pub fn get_management_dns_zone_binding( &self, name: impl Into<String>, ) -> GetManagementDnsZoneBinding

Retrieves a ‘ManagementDnsZoneBinding’ resource by its resource name.

pub fn create_management_dns_zone_binding( &self, parent: impl Into<String>, ) -> CreateManagementDnsZoneBinding

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_management_dns_zone_binding( &self, management_dns_zone_binding: impl Into<ManagementDnsZoneBinding>, ) -> UpdateManagementDnsZoneBinding

Updates a ManagementDnsZoneBinding resource. Only fields specified in update_mask are applied.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_management_dns_zone_binding( &self, name: impl Into<String>, ) -> DeleteManagementDnsZoneBinding

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn repair_management_dns_zone_binding( &self, name: impl Into<String>, ) -> RepairManagementDnsZoneBinding

Retries to create a ManagementDnsZoneBinding resource that is in failed state.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_vmware_engine_network( &self, parent: impl Into<String>, ) -> CreateVmwareEngineNetwork

Creates a new VMware Engine network that can be used by a private cloud.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_vmware_engine_network( &self, vmware_engine_network: impl Into<VmwareEngineNetwork>, ) -> UpdateVmwareEngineNetwork

Modifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_vmware_engine_network( &self, name: impl Into<String>, ) -> DeleteVmwareEngineNetwork

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_vmware_engine_network( &self, name: impl Into<String>, ) -> GetVmwareEngineNetwork

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

pub fn list_vmware_engine_networks( &self, parent: impl Into<String>, ) -> ListVmwareEngineNetworks

Lists VmwareEngineNetwork resources in a given project and location.

pub fn create_private_connection( &self, parent: impl Into<String>, ) -> CreatePrivateConnection

Creates a new private connection that can be used for accessing private Clouds.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_private_connection( &self, name: impl Into<String>, ) -> GetPrivateConnection

Retrieves a PrivateConnection resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.

pub fn list_private_connections( &self, parent: impl Into<String>, ) -> ListPrivateConnections

Lists PrivateConnection resources in a given project and location.

pub fn update_private_connection( &self, private_connection: impl Into<PrivateConnection>, ) -> UpdatePrivateConnection

Modifies a PrivateConnection resource. Only description and routing_mode fields can be updated. Only fields specified in updateMask are applied.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_private_connection( &self, name: impl Into<String>, ) -> DeletePrivateConnection

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_private_connection_peering_routes( &self, parent: impl Into<String>, ) -> ListPrivateConnectionPeeringRoutes

Lists the private connection routes exchanged over a peering connection.

pub fn grant_dns_bind_permission( &self, name: impl Into<String>, ) -> GrantDnsBindPermission

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_dns_bind_permission( &self, name: impl Into<String>, ) -> GetDnsBindPermission

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.

pub fn revoke_dns_bind_permission( &self, name: impl Into<String>, ) -> RevokeDnsBindPermission

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.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_locations(&self, name: impl Into<String>) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self, name: impl Into<String>) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self, resource: impl Into<String>) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self, resource: impl Into<String>) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions( &self, resource: impl Into<String>, ) -> TestIamPermissions

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.

pub fn list_operations(&self, name: impl Into<String>) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self, name: impl Into<String>) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self, name: impl Into<String>) -> DeleteOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for VmwareEngine

fn clone(&self) -> VmwareEngine

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VmwareEngine

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.