// Copyright 2022 Luca Casonato. All rights reserved. MIT license. /** * VMware Engine API Client for Deno * ================================= * * The Google VMware Engine API lets you programmatically manage VMware environments. * * Docs: https://cloud.google.com/solutions/vmware-as-a-service * Source: https://googleapis.deno.dev/v1/vmwareengine:v1.ts */ import { auth, CredentialsClient, GoogleAuth, request } from "/_/base@v1/mod.ts"; export { auth, GoogleAuth }; export type { CredentialsClient }; /** * The Google VMware Engine API lets you programmatically manage VMware * environments. */ export class VMwareEngine { #client: CredentialsClient | undefined; #baseUrl: string; constructor(client?: CredentialsClient, baseUrl: string = "https://vmwareengine.googleapis.com/") { this.#client = client; this.#baseUrl = baseUrl; } /** * 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. * * @param name 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` */ async projectsLocationsDnsBindPermissionGrant(name: string, req: GrantDnsBindPermissionRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:grant`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsDnsBindPermissionRevoke(name: string, req: RevokeDnsBindPermissionRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:revoke`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Gets information about a location. * * @param name Resource name for the location. */ async projectsLocationsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Location; } /** * 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. * * @param name 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` */ async projectsLocationsGetDnsBindPermission(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as DnsBindPermission; } /** * Lists information about the supported locations for this service. * * @param name The resource that owns the locations collection, if applicable. */ async projectsLocationsList(name: string, opts: ProjectsLocationsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }/locations`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListLocationsResponse; } /** * 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. * * @param parent 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` */ async projectsLocationsNetworkPeeringsCreate(parent: string, req: NetworkPeering, opts: ProjectsLocationsNetworkPeeringsCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/networkPeerings`); if (opts.networkPeeringId !== undefined) { url.searchParams.append("networkPeeringId", String(opts.networkPeeringId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsNetworkPeeringsDelete(name: string, opts: ProjectsLocationsNetworkPeeringsDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsNetworkPeeringsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as NetworkPeering; } /** * Lists `NetworkPeering` resources in a given project. NetworkPeering is a * global resource and location can only be global. * * @param parent 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` */ async projectsLocationsNetworkPeeringsList(parent: string, opts: ProjectsLocationsNetworkPeeringsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/networkPeerings`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListNetworkPeeringsResponse; } /** * 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. * * @param name Output only. Identifier. The resource name of the network peering. NetworkPeering is a global resource and location can only be global. Resource names are scheme-less URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/networkPeerings/my-peering` */ async projectsLocationsNetworkPeeringsPatch(name: string, req: NetworkPeering, opts: ProjectsLocationsNetworkPeeringsPatchOptions = {}): Promise { opts = serializeProjectsLocationsNetworkPeeringsPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Lists the network peering routes exchanged over a peering connection. * NetworkPeering is a global resource and location can only be global. * * @param parent 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` */ async projectsLocationsNetworkPeeringsPeeringRoutesList(parent: string, opts: ProjectsLocationsNetworkPeeringsPeeringRoutesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/peeringRoutes`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListPeeringRoutesResponse; } /** * 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. * * @param parent 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` */ async projectsLocationsNetworkPoliciesCreate(parent: string, req: NetworkPolicy, opts: ProjectsLocationsNetworkPoliciesCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/networkPolicies`); if (opts.networkPolicyId !== undefined) { url.searchParams.append("networkPolicyId", String(opts.networkPolicyId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsNetworkPoliciesDelete(name: string, opts: ProjectsLocationsNetworkPoliciesDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Creates a new external access rule in a given network policy. * * @param parent 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` */ async projectsLocationsNetworkPoliciesExternalAccessRulesCreate(parent: string, req: ExternalAccessRule, opts: ProjectsLocationsNetworkPoliciesExternalAccessRulesCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/externalAccessRules`); if (opts.externalAccessRuleId !== undefined) { url.searchParams.append("externalAccessRuleId", String(opts.externalAccessRuleId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Deletes a single external access rule. * * @param name 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` */ async projectsLocationsNetworkPoliciesExternalAccessRulesDelete(name: string, opts: ProjectsLocationsNetworkPoliciesExternalAccessRulesDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Gets details of a single external access rule. * * @param name 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` */ async projectsLocationsNetworkPoliciesExternalAccessRulesGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ExternalAccessRule; } /** * Lists `ExternalAccessRule` resources in the specified network policy. * * @param parent 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` */ async projectsLocationsNetworkPoliciesExternalAccessRulesList(parent: string, opts: ProjectsLocationsNetworkPoliciesExternalAccessRulesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/externalAccessRules`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListExternalAccessRulesResponse; } /** * Updates the parameters of a single external access rule. Only fields * specified in `update_mask` are applied. * * @param name Output only. The resource name of this external access rule. 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` */ async projectsLocationsNetworkPoliciesExternalAccessRulesPatch(name: string, req: ExternalAccessRule, opts: ProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions = {}): Promise { opts = serializeProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Lists external IP addresses assigned to VMware workload VMs within the * scope of the given network policy. * * @param networkPolicy 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` */ async projectsLocationsNetworkPoliciesFetchExternalAddresses(networkPolicy: string, opts: ProjectsLocationsNetworkPoliciesFetchExternalAddressesOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ networkPolicy }:fetchExternalAddresses`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as FetchNetworkPolicyExternalAddressesResponse; } /** * Retrieves a `NetworkPolicy` resource by its resource name. * * @param name 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` */ async projectsLocationsNetworkPoliciesGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as NetworkPolicy; } /** * Lists `NetworkPolicy` resources in a specified project and location. * * @param parent 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` */ async projectsLocationsNetworkPoliciesList(parent: string, opts: ProjectsLocationsNetworkPoliciesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/networkPolicies`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListNetworkPoliciesResponse; } /** * 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. * * @param name Output only. Identifier. The resource name of this network policy. 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` */ async projectsLocationsNetworkPoliciesPatch(name: string, req: NetworkPolicy, opts: ProjectsLocationsNetworkPoliciesPatchOptions = {}): Promise { opts = serializeProjectsLocationsNetworkPoliciesPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Gets details of a single `NodeType`. * * @param name 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` */ async projectsLocationsNodeTypesGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as NodeType; } /** * Lists node types * * @param parent 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` */ async projectsLocationsNodeTypesList(parent: string, opts: ProjectsLocationsNodeTypesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/nodeTypes`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListNodeTypesResponse; } /** * 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`. * * @param name The name of the operation resource to be deleted. */ async projectsLocationsOperationsDelete(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Empty; } /** * 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. * * @param name The name of the operation resource. */ async projectsLocationsOperationsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Operation; } /** * Lists operations that match the specified filter in the request. If the * server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param name The name of the operation's parent resource. */ async projectsLocationsOperationsList(name: string, opts: ProjectsLocationsOperationsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }/operations`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListOperationsResponse; } /** * 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). * * @param parent 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` */ async projectsLocationsPrivateCloudsClustersCreate(parent: string, req: Cluster, opts: ProjectsLocationsPrivateCloudsClustersCreateOptions = {}): Promise { req = serializeCluster(req); const url = new URL(`${this.#baseUrl}v1/${ parent }/clusters`); if (opts.clusterId !== undefined) { url.searchParams.append("clusterId", String(opts.clusterId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsPrivateCloudsClustersDelete(name: string, opts: ProjectsLocationsPrivateCloudsClustersDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Retrieves a `Cluster` resource by its resource name. * * @param name 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` */ async projectsLocationsPrivateCloudsClustersGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeCluster(data); } /** * Gets the access control policy for a resource. Returns an empty policy if * the resource exists and does not have a policy set. * * @param resource REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsClustersGetIamPolicy(resource: string, opts: ProjectsLocationsPrivateCloudsClustersGetIamPolicyOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ resource }:getIamPolicy`); if (opts["options.requestedPolicyVersion"] !== undefined) { url.searchParams.append("options.requestedPolicyVersion", String(opts["options.requestedPolicyVersion"])); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializePolicy(data); } /** * Lists `Cluster` resources in a given private cloud. * * @param parent 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` */ async projectsLocationsPrivateCloudsClustersList(parent: string, opts: ProjectsLocationsPrivateCloudsClustersListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/clusters`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializeListClustersResponse(data); } /** * Gets details of a single node. * * @param name Required. The resource name of the node to retrieve. For example: `projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}` */ async projectsLocationsPrivateCloudsClustersNodesGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Node; } /** * Lists nodes in a given cluster. * * @param parent 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` */ async projectsLocationsPrivateCloudsClustersNodesList(parent: string, opts: ProjectsLocationsPrivateCloudsClustersNodesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/nodes`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListNodesResponse; } /** * 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. * * @param name Output only. Identifier. The resource name of this cluster. 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` */ async projectsLocationsPrivateCloudsClustersPatch(name: string, req: Cluster, opts: ProjectsLocationsPrivateCloudsClustersPatchOptions = {}): Promise { req = serializeCluster(req); opts = serializeProjectsLocationsPrivateCloudsClustersPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Sets the access control policy on the specified resource. Replaces any * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and * `PERMISSION_DENIED` errors. * * @param resource REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsClustersSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise { req = serializeSetIamPolicyRequest(req); const url = new URL(`${this.#baseUrl}v1/${ resource }:setIamPolicy`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return deserializePolicy(data); } /** * 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. * * @param resource REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsClustersTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ resource }:testIamPermissions`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as TestIamPermissionsResponse; } /** * 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. * * @param parent 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` */ async projectsLocationsPrivateCloudsCreate(parent: string, req: PrivateCloud, opts: ProjectsLocationsPrivateCloudsCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/privateClouds`); if (opts.privateCloudId !== undefined) { url.searchParams.append("privateCloudId", String(opts.privateCloudId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.validateOnly !== undefined) { url.searchParams.append("validateOnly", String(opts.validateOnly)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsPrivateCloudsDelete(name: string, opts: ProjectsLocationsPrivateCloudsDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.delayHours !== undefined) { url.searchParams.append("delayHours", String(opts.delayHours)); } if (opts.force !== undefined) { url.searchParams.append("force", String(opts.force)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * 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`). * * @param parent 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` */ async projectsLocationsPrivateCloudsExternalAddressesCreate(parent: string, req: ExternalAddress, opts: ProjectsLocationsPrivateCloudsExternalAddressesCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/externalAddresses`); if (opts.externalAddressId !== undefined) { url.searchParams.append("externalAddressId", String(opts.externalAddressId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsPrivateCloudsExternalAddressesDelete(name: string, opts: ProjectsLocationsPrivateCloudsExternalAddressesDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Gets details of a single external IP address. * * @param name 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` */ async projectsLocationsPrivateCloudsExternalAddressesGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ExternalAddress; } /** * Lists external IP addresses assigned to VMware workload VMs in a given * private cloud. * * @param parent 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` */ async projectsLocationsPrivateCloudsExternalAddressesList(parent: string, opts: ProjectsLocationsPrivateCloudsExternalAddressesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/externalAddresses`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListExternalAddressesResponse; } /** * 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. * * @param name Output only. Identifier. The resource name of this external IP address. 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-address` */ async projectsLocationsPrivateCloudsExternalAddressesPatch(name: string, req: ExternalAddress, opts: ProjectsLocationsPrivateCloudsExternalAddressesPatchOptions = {}): Promise { opts = serializeProjectsLocationsPrivateCloudsExternalAddressesPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Retrieves a `PrivateCloud` resource by its resource name. * * @param name 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` */ async projectsLocationsPrivateCloudsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as PrivateCloud; } /** * Gets details of the `DnsForwarding` config. * * @param name 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` */ async projectsLocationsPrivateCloudsGetDnsForwarding(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as DnsForwarding; } /** * Gets the access control policy for a resource. Returns an empty policy if * the resource exists and does not have a policy set. * * @param resource REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsGetIamPolicy(resource: string, opts: ProjectsLocationsPrivateCloudsGetIamPolicyOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ resource }:getIamPolicy`); if (opts["options.requestedPolicyVersion"] !== undefined) { url.searchParams.append("options.requestedPolicyVersion", String(opts["options.requestedPolicyVersion"])); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializePolicy(data); } /** * Creates a new HCX activation key in a given private cloud. * * @param parent 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` */ async projectsLocationsPrivateCloudsHcxActivationKeysCreate(parent: string, req: HcxActivationKey, opts: ProjectsLocationsPrivateCloudsHcxActivationKeysCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/hcxActivationKeys`); if (opts.hcxActivationKeyId !== undefined) { url.searchParams.append("hcxActivationKeyId", String(opts.hcxActivationKeyId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Retrieves a `HcxActivationKey` resource by its resource name. * * @param name 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` */ async projectsLocationsPrivateCloudsHcxActivationKeysGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as HcxActivationKey; } /** * Gets the access control policy for a resource. Returns an empty policy if * the resource exists and does not have a policy set. * * @param resource REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsHcxActivationKeysGetIamPolicy(resource: string, opts: ProjectsLocationsPrivateCloudsHcxActivationKeysGetIamPolicyOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ resource }:getIamPolicy`); if (opts["options.requestedPolicyVersion"] !== undefined) { url.searchParams.append("options.requestedPolicyVersion", String(opts["options.requestedPolicyVersion"])); } const data = await request(url.href, { client: this.#client, method: "GET", }); return deserializePolicy(data); } /** * Lists `HcxActivationKey` resources in a given private cloud. * * @param parent 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` */ async projectsLocationsPrivateCloudsHcxActivationKeysList(parent: string, opts: ProjectsLocationsPrivateCloudsHcxActivationKeysListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/hcxActivationKeys`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListHcxActivationKeysResponse; } /** * Sets the access control policy on the specified resource. Replaces any * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and * `PERMISSION_DENIED` errors. * * @param resource REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsHcxActivationKeysSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise { req = serializeSetIamPolicyRequest(req); const url = new URL(`${this.#baseUrl}v1/${ resource }:setIamPolicy`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return deserializePolicy(data); } /** * 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. * * @param resource REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsHcxActivationKeysTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ resource }:testIamPermissions`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as TestIamPermissionsResponse; } /** * Lists `PrivateCloud` resources in a given project and location. * * @param parent 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` */ async projectsLocationsPrivateCloudsList(parent: string, opts: ProjectsLocationsPrivateCloudsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/privateClouds`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListPrivateCloudsResponse; } /** * Create a new logging server for a given private cloud. * * @param parent 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` */ async projectsLocationsPrivateCloudsLoggingServersCreate(parent: string, req: LoggingServer, opts: ProjectsLocationsPrivateCloudsLoggingServersCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/loggingServers`); if (opts.loggingServerId !== undefined) { url.searchParams.append("loggingServerId", String(opts.loggingServerId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Deletes a single logging server. * * @param name 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` */ async projectsLocationsPrivateCloudsLoggingServersDelete(name: string, opts: ProjectsLocationsPrivateCloudsLoggingServersDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Gets details of a logging server. * * @param name 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` */ async projectsLocationsPrivateCloudsLoggingServersGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as LoggingServer; } /** * Lists logging servers configured for a given private cloud. * * @param parent 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` */ async projectsLocationsPrivateCloudsLoggingServersList(parent: string, opts: ProjectsLocationsPrivateCloudsLoggingServersListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/loggingServers`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListLoggingServersResponse; } /** * Updates the parameters of a single logging server. Only fields specified * in `update_mask` are applied. * * @param name Output only. The resource name of this logging server. 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` */ async projectsLocationsPrivateCloudsLoggingServersPatch(name: string, req: LoggingServer, opts: ProjectsLocationsPrivateCloudsLoggingServersPatchOptions = {}): Promise { opts = serializeProjectsLocationsPrivateCloudsLoggingServersPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * 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. * * @param parent 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` */ async projectsLocationsPrivateCloudsManagementDnsZoneBindingsCreate(parent: string, req: ManagementDnsZoneBinding, opts: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/managementDnsZoneBindings`); if (opts.managementDnsZoneBindingId !== undefined) { url.searchParams.append("managementDnsZoneBindingId", String(opts.managementDnsZoneBindingId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsPrivateCloudsManagementDnsZoneBindingsDelete(name: string, opts: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Retrieves a 'ManagementDnsZoneBinding' resource by its resource name. * * @param name 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` */ async projectsLocationsPrivateCloudsManagementDnsZoneBindingsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ManagementDnsZoneBinding; } /** * Lists Consumer VPCs bound to Management DNS Zone of a given private cloud. * * @param parent 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` */ async projectsLocationsPrivateCloudsManagementDnsZoneBindingsList(parent: string, opts: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/managementDnsZoneBindings`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListManagementDnsZoneBindingsResponse; } /** * Updates a `ManagementDnsZoneBinding` resource. Only fields specified in * `update_mask` are applied. * * @param name Output only. The resource name of this binding. 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` */ async projectsLocationsPrivateCloudsManagementDnsZoneBindingsPatch(name: string, req: ManagementDnsZoneBinding, opts: ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions = {}): Promise { opts = serializeProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Retries to create a `ManagementDnsZoneBinding` resource that is in failed * state. * * @param name 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` */ async projectsLocationsPrivateCloudsManagementDnsZoneBindingsRepair(name: string, req: RepairManagementDnsZoneBindingRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:repair`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name Output only. Identifier. The resource name of this private cloud. 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` */ async projectsLocationsPrivateCloudsPatch(name: string, req: PrivateCloud, opts: ProjectsLocationsPrivateCloudsPatchOptions = {}): Promise { opts = serializeProjectsLocationsPrivateCloudsPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Resets credentials of the NSX appliance. * * @param privateCloud 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` */ async projectsLocationsPrivateCloudsResetNsxCredentials(privateCloud: string, req: ResetNsxCredentialsRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ privateCloud }:resetNsxCredentials`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Resets credentials of the Vcenter appliance. * * @param privateCloud 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` */ async projectsLocationsPrivateCloudsResetVcenterCredentials(privateCloud: string, req: ResetVcenterCredentialsRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ privateCloud }:resetVcenterCredentials`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Sets the access control policy on the specified resource. Replaces any * existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and * `PERMISSION_DENIED` errors. * * @param resource REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise { req = serializeSetIamPolicyRequest(req); const url = new URL(`${this.#baseUrl}v1/${ resource }:setIamPolicy`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return deserializePolicy(data); } /** * Gets details of credentials for NSX appliance. * * @param privateCloud 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` */ async projectsLocationsPrivateCloudsShowNsxCredentials(privateCloud: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ privateCloud }:showNsxCredentials`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Credentials; } /** * Gets details of credentials for Vcenter appliance. * * @param privateCloud 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` */ async projectsLocationsPrivateCloudsShowVcenterCredentials(privateCloud: string, opts: ProjectsLocationsPrivateCloudsShowVcenterCredentialsOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ privateCloud }:showVcenterCredentials`); if (opts.username !== undefined) { url.searchParams.append("username", String(opts.username)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Credentials; } /** * Gets details of a single subnet. * * @param name 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` */ async projectsLocationsPrivateCloudsSubnetsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as Subnet; } /** * Lists subnets in a given private cloud. * * @param parent 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` */ async projectsLocationsPrivateCloudsSubnetsList(parent: string, opts: ProjectsLocationsPrivateCloudsSubnetsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/subnets`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListSubnetsResponse; } /** * 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. * * @param name Output only. Identifier. The resource name of this subnet. 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` */ async projectsLocationsPrivateCloudsSubnetsPatch(name: string, req: Subnet, opts: ProjectsLocationsPrivateCloudsSubnetsPatchOptions = {}): Promise { opts = serializeProjectsLocationsPrivateCloudsSubnetsPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * 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. * * @param resource REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ async projectsLocationsPrivateCloudsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ resource }:testIamPermissions`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as TestIamPermissionsResponse; } /** * 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. * * @param name 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` */ async projectsLocationsPrivateCloudsUndelete(name: string, req: UndeletePrivateCloudRequest): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }:undelete`); const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * Updates the parameters of the `DnsForwarding` config, like associated * domains. Only fields specified in `update_mask` are applied. * * @param name Output only. Identifier. The resource name of this DNS profile. 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` */ async projectsLocationsPrivateCloudsUpdateDnsForwarding(name: string, req: DnsForwarding, opts: ProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions = {}): Promise { opts = serializeProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Creates a new private connection that can be used for accessing private * Clouds. * * @param parent 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` */ async projectsLocationsPrivateConnectionsCreate(parent: string, req: PrivateConnection, opts: ProjectsLocationsPrivateConnectionsCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/privateConnections`); if (opts.privateConnectionId !== undefined) { url.searchParams.append("privateConnectionId", String(opts.privateConnectionId)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsPrivateConnectionsDelete(name: string, opts: ProjectsLocationsPrivateConnectionsDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * Retrieves a `PrivateConnection` resource by its resource name. The * resource contains details of the private connection, such as connected * network, routing mode and state. * * @param name 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` */ async projectsLocationsPrivateConnectionsGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as PrivateConnection; } /** * Lists `PrivateConnection` resources in a given project and location. * * @param parent 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` */ async projectsLocationsPrivateConnectionsList(parent: string, opts: ProjectsLocationsPrivateConnectionsListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/privateConnections`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListPrivateConnectionsResponse; } /** * Modifies a `PrivateConnection` resource. Only `description` and * `routing_mode` fields can be updated. Only fields specified in `updateMask` * are applied. * * @param name Output only. The resource name of the private connection. 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` */ async projectsLocationsPrivateConnectionsPatch(name: string, req: PrivateConnection, opts: ProjectsLocationsPrivateConnectionsPatchOptions = {}): Promise { opts = serializeProjectsLocationsPrivateConnectionsPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } /** * Lists the private connection routes exchanged over a peering connection. * * @param parent 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` */ async projectsLocationsPrivateConnectionsPeeringRoutesList(parent: string, opts: ProjectsLocationsPrivateConnectionsPeeringRoutesListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/peeringRoutes`); if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListPrivateConnectionPeeringRoutesResponse; } /** * Creates a new VMware Engine network that can be used by a private cloud. * * @param parent 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` */ async projectsLocationsVmwareEngineNetworksCreate(parent: string, req: VmwareEngineNetwork, opts: ProjectsLocationsVmwareEngineNetworksCreateOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/vmwareEngineNetworks`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.vmwareEngineNetworkId !== undefined) { url.searchParams.append("vmwareEngineNetworkId", String(opts.vmwareEngineNetworkId)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "POST", body, }); return data as Operation; } /** * 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. * * @param name 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` */ async projectsLocationsVmwareEngineNetworksDelete(name: string, opts: ProjectsLocationsVmwareEngineNetworksDeleteOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.etag !== undefined) { url.searchParams.append("etag", String(opts.etag)); } if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } const data = await request(url.href, { client: this.#client, method: "DELETE", }); return data as Operation; } /** * 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`). * * @param name 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` */ async projectsLocationsVmwareEngineNetworksGet(name: string): Promise { const url = new URL(`${this.#baseUrl}v1/${ name }`); const data = await request(url.href, { client: this.#client, method: "GET", }); return data as VmwareEngineNetwork; } /** * Lists `VmwareEngineNetwork` resources in a given project and location. * * @param parent 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` */ async projectsLocationsVmwareEngineNetworksList(parent: string, opts: ProjectsLocationsVmwareEngineNetworksListOptions = {}): Promise { const url = new URL(`${this.#baseUrl}v1/${ parent }/vmwareEngineNetworks`); if (opts.filter !== undefined) { url.searchParams.append("filter", String(opts.filter)); } if (opts.orderBy !== undefined) { url.searchParams.append("orderBy", String(opts.orderBy)); } if (opts.pageSize !== undefined) { url.searchParams.append("pageSize", String(opts.pageSize)); } if (opts.pageToken !== undefined) { url.searchParams.append("pageToken", String(opts.pageToken)); } const data = await request(url.href, { client: this.#client, method: "GET", }); return data as ListVmwareEngineNetworksResponse; } /** * Modifies a VMware Engine network resource. Only the following fields can * be updated: `description`. Only fields specified in `updateMask` are * applied. * * @param name Output only. Identifier. The resource name of the VMware Engine network. 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` */ async projectsLocationsVmwareEngineNetworksPatch(name: string, req: VmwareEngineNetwork, opts: ProjectsLocationsVmwareEngineNetworksPatchOptions = {}): Promise { opts = serializeProjectsLocationsVmwareEngineNetworksPatchOptions(opts); const url = new URL(`${this.#baseUrl}v1/${ name }`); if (opts.requestId !== undefined) { url.searchParams.append("requestId", String(opts.requestId)); } if (opts.updateMask !== undefined) { url.searchParams.append("updateMask", String(opts.updateMask)); } const body = JSON.stringify(req); const data = await request(url.href, { client: this.#client, method: "PATCH", body, }); return data as Operation; } } /** * Specifies the audit configuration for a service. The configuration * determines which permission types are logged, and what identities, if any, * are exempted from logging. An AuditConfig must have one or more * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a * specific service, the union of the two AuditConfigs is used for that service: * the log_types specified in each AuditConfig are enabled, and the * exempted_members in each AuditLogConfig are exempted. Example Policy with * multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", * "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ * "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": * "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", * "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": * "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For * sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ * logging. It also exempts `jose@example.com` from DATA_READ logging, and * `aliya@example.com` from DATA_WRITE logging. */ export interface AuditConfig { /** * The configuration for logging of each type of permission. */ auditLogConfigs?: AuditLogConfig[]; /** * Specifies a service that will be enabled for audit logging. For example, * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a * special value that covers all services. */ service?: string; } /** * Provides the configuration for logging a type of permissions. Example: { * "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ * "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables * 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from * DATA_READ logging. */ export interface AuditLogConfig { /** * Specifies the identities that do not cause logging for this type of * permission. Follows the same format of Binding.members. */ exemptedMembers?: string[]; /** * The log type that this config enables. */ logType?: | "LOG_TYPE_UNSPECIFIED" | "ADMIN_READ" | "DATA_WRITE" | "DATA_READ"; } /** * Autoscaling policy describes the behavior of the autoscaling with respect to * the resource utilization. The scale-out operation is initiated if the * utilization exceeds ANY of the respective thresholds. The scale-in operation * is initiated if the utilization is below ALL of the respective thresholds. */ export interface AutoscalingPolicy { /** * Optional. Utilization thresholds pertaining to amount of consumed memory. */ consumedMemoryThresholds?: Thresholds; /** * Optional. Utilization thresholds pertaining to CPU utilization. */ cpuThresholds?: Thresholds; /** * Optional. Utilization thresholds pertaining to amount of granted memory. */ grantedMemoryThresholds?: Thresholds; /** * Required. The canonical identifier of the node type to add or remove. * Corresponds to the `NodeType`. */ nodeTypeId?: string; /** * Required. Number of nodes to add to a cluster during a scale-out * operation. Must be divisible by 2 for stretched clusters. During a scale-in * operation only one node (or 2 for stretched clusters) are removed in a * single iteration. */ scaleOutSize?: number; /** * Optional. Utilization thresholds pertaining to amount of consumed storage. */ storageThresholds?: Thresholds; } /** * Autoscaling settings define the rules used by VMware Engine to automatically * scale-out and scale-in the clusters in a private cloud. */ export interface AutoscalingSettings { /** * Required. The map with autoscaling policies applied to the cluster. The * key is the identifier of the policy. It 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) * Currently there map must contain only one element that describes the * autoscaling policy for compute nodes. */ autoscalingPolicies?: { [key: string]: AutoscalingPolicy }; /** * Optional. The minimum duration between consecutive autoscale operations. * It starts once addition or removal of nodes is fully completed. Defaults to * 30 minutes if not specified. Cool down period must be in whole minutes (for * example, 30, 31, 50, 180 minutes). */ coolDownPeriod?: number /* Duration */; /** * Optional. Maximum number of nodes of any type in a cluster. If not * specified the default limits apply. */ maxClusterNodeCount?: number; /** * Optional. Minimum number of nodes of any type in a cluster. If not * specified the default limits apply. */ minClusterNodeCount?: number; } function serializeAutoscalingSettings(data: any): AutoscalingSettings { return { ...data, coolDownPeriod: data["coolDownPeriod"] !== undefined ? data["coolDownPeriod"] : undefined, }; } function deserializeAutoscalingSettings(data: any): AutoscalingSettings { return { ...data, coolDownPeriod: data["coolDownPeriod"] !== undefined ? data["coolDownPeriod"] : undefined, }; } /** * Associates `members`, or principals, with a `role`. */ export interface Binding { /** * The condition that is associated with this binding. If the condition * evaluates to `true`, then this binding applies to the current request. If * the condition evaluates to `false`, then this binding does not apply to the * current request. However, a different role binding might grant the same * role to one or more of the principals in this binding. To learn which * resources support conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ condition?: Expr; /** * Specifies the principals requesting access for a Google Cloud resource. * `members` can have the following values: * `allUsers`: A special identifier * that represents anyone who is on the internet; with or without a Google * account. * `allAuthenticatedUsers`: A special identifier that represents * anyone who is authenticated with a Google account or a service account. * Does not include identities that come from external identity providers * (IdPs) through identity federation. * `user:{emailid}`: An email address * that represents a specific Google account. For example, `alice@example.com` * . * `serviceAccount:{emailid}`: An email address that represents a Google * service account. For example, `my-other-app@appspot.gserviceaccount.com`. * * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An * identifier for a [Kubernetes service * account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). * For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * * `group:{emailid}`: An email address that represents a Google group. For * example, `admins@example.com`. * `domain:{domain}`: The G Suite domain * (primary) that represents all the users of that domain. For example, * `google.com` or `example.com`. * * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: * A single identity in a workforce identity pool. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: * All workforce identities in a group. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: * All workforce identities with a specific attribute value. * * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: * All identities in a workforce identity pool. * * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: * A single identity in a workload identity pool. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: * A workload identity pool group. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: * All identities in a workload identity pool with a certain attribute. * * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: * All identities in a workload identity pool. * * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique * identifier) representing a user that has been recently deleted. For * example, `alice@example.com?uid=123456789012345678901`. If the user is * recovered, this value reverts to `user:{emailid}` and the recovered user * retains the role in the binding. * * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus * unique identifier) representing a service account that has been recently * deleted. For example, * `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If * the service account is undeleted, this value reverts to * `serviceAccount:{emailid}` and the undeleted service account retains the * role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email * address (plus unique identifier) representing a Google group that has been * recently deleted. For example, * `admins@example.com?uid=123456789012345678901`. If the group is recovered, * this value reverts to `group:{emailid}` and the recovered group retains the * role in the binding. * * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: * Deleted single identity in a workforce identity pool. For example, * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. */ members?: string[]; /** * Role that is assigned to the list of `members`, or principals. For * example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview * of the IAM roles and permissions, see the [IAM * documentation](https://cloud.google.com/iam/docs/roles-overview). For a * list of the available pre-defined roles, see * [here](https://cloud.google.com/iam/docs/understanding-roles). */ role?: string; } /** * A cluster in a private cloud. */ export interface Cluster { /** * Optional. Configuration of the autoscaling applied to this cluster. */ autoscalingSettings?: AutoscalingSettings; /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * Output only. True if the cluster is a management cluster; false otherwise. * There can only be one management cluster in a private cloud and it has to * be the first one. */ readonly management?: boolean; /** * Output only. Identifier. The resource name of this cluster. 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` */ readonly name?: string; /** * Required. The map of cluster node types in this cluster, where the key is * canonical identifier of the node type (corresponds to the `NodeType`). */ nodeTypeConfigs?: { [key: string]: NodeTypeConfig }; /** * Output only. State of the resource. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING" | "UPDATING" | "DELETING" | "REPAIRING"; /** * Optional. Configuration of a stretched cluster. Required for clusters that * belong to a STRETCHED private cloud. */ stretchedClusterConfig?: StretchedClusterConfig; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; } function serializeCluster(data: any): Cluster { return { ...data, autoscalingSettings: data["autoscalingSettings"] !== undefined ? serializeAutoscalingSettings(data["autoscalingSettings"]) : undefined, }; } function deserializeCluster(data: any): Cluster { return { ...data, autoscalingSettings: data["autoscalingSettings"] !== undefined ? deserializeAutoscalingSettings(data["autoscalingSettings"]) : undefined, createTime: data["createTime"] !== undefined ? new Date(data["createTime"]) : undefined, updateTime: data["updateTime"] !== undefined ? new Date(data["updateTime"]) : undefined, }; } /** * Credentials for a private cloud. */ export interface Credentials { /** * Initial password. */ password?: string; /** * Initial username. */ username?: string; } /** * DnsBindPermission resource that contains the accounts having the consumer * DNS bind permission on the corresponding intranet VPC of the consumer * project. */ export interface DnsBindPermission { /** * Required. Output only. 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 and location can only be global. 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` */ readonly name?: string; /** * Output only. Users/Service accounts which have access for binding on the * intranet VPC project corresponding to the consumer project. */ readonly principals?: Principal[]; } /** * DNS forwarding config. This config defines a list of domain to name server * mappings, and is attached to the private cloud for custom domain resolution. */ export interface DnsForwarding { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * Required. List of domain mappings to configure */ forwardingRules?: ForwardingRule[]; /** * Output only. Identifier. The resource name of this DNS profile. 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` */ readonly name?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; } /** * A generic empty message that you can re-use to avoid defining duplicated * empty messages in your APIs. A typical example is to use it as the request or * the response type of an API method. For instance: service Foo { rpc * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } */ export interface Empty { } /** * Represents a textual expression in the Common Expression Language (CEL) * syntax. CEL is a C-like expression language. The syntax and semantics of CEL * are documented at https://github.com/google/cel-spec. Example (Comparison): * title: "Summary size limit" description: "Determines if a summary is less * than 100 chars" expression: "document.summary.size() < 100" Example * (Equality): title: "Requestor is owner" description: "Determines if requestor * is the document owner" expression: "document.owner == * request.auth.claims.email" Example (Logic): title: "Public documents" * description: "Determine whether the document should be publicly visible" * expression: "document.type != 'private' && document.type != 'internal'" * Example (Data Manipulation): title: "Notification string" description: * "Create a notification string with a timestamp." expression: "'New message * received at ' + string(document.create_time)" The exact variables and * functions that may be referenced within an expression are determined by the * service that evaluates it. See the service documentation for additional * information. */ export interface Expr { /** * Optional. Description of the expression. This is a longer text which * describes the expression, e.g. when hovered over it in a UI. */ description?: string; /** * Textual representation of an expression in Common Expression Language * syntax. */ expression?: string; /** * Optional. String indicating the location of the expression for error * reporting, e.g. a file name and a position in the file. */ location?: string; /** * Optional. Title for the expression, i.e. a short string describing its * purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string; } /** * External access firewall rules for filtering incoming traffic destined to * `ExternalAddress` resources. */ export interface ExternalAccessRule { /** * The action that the external access rule performs. */ action?: | "ACTION_UNSPECIFIED" | "ALLOW" | "DENY"; /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * User-provided description for this external access rule. */ description?: string; /** * If destination ranges are specified, the external access rule applies only * to the traffic that has a destination IP address in these ranges. The * specified IP addresses must have reserved external IP addresses in the * scope of the parent network policy. To match all external IP addresses in * the scope of the parent network policy, specify `0.0.0.0/0`. To match a * specific external IP address, specify it using the * `IpRange.external_address` property. */ destinationIpRanges?: IpRange[]; /** * A list of destination ports to which the external access rule applies. * This field is only applicable for the UDP or TCP protocol. Each entry must * be either an integer or a range. For example: `["22"]`, `["80","443"]`, or * `["12345-12349"]`. To match all destination ports, specify `["0-65535"]`. */ destinationPorts?: string[]; /** * The IP protocol to which the external access rule applies. This value can * be one of the following three protocol strings (not case-sensitive): `tcp`, * `udp`, or `icmp`. */ ipProtocol?: string; /** * Output only. The resource name of this external access rule. 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` */ readonly name?: string; /** * External access rule priority, which determines the external access rule * to use when multiple rules apply. If multiple rules have the same priority, * their ordering is non-deterministic. If specific ordering is required, * assign unique priorities to enforce such ordering. The external access rule * priority is an integer from 100 to 4096, both inclusive. Lower integers * indicate higher precedence. For example, a rule with priority `100` has * higher precedence than a rule with priority `101`. */ priority?: number; /** * If source ranges are specified, the external access rule applies only to * traffic that has a source IP address in these ranges. These ranges can * either be expressed in the CIDR format or as an IP address. As only inbound * rules are supported, `ExternalAddress` resources cannot be the source IP * addresses of an external access rule. To match all source addresses, * specify `0.0.0.0/0`. */ sourceIpRanges?: IpRange[]; /** * A list of source ports to which the external access rule applies. This * field is only applicable for the UDP or TCP protocol. Each entry must be * either an integer or a range. For example: `["22"]`, `["80","443"]`, or * `["12345-12349"]`. To match all source ports, specify `["0-65535"]`. */ sourcePorts?: string[]; /** * Output only. The state of the resource. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING" | "UPDATING" | "DELETING"; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; } /** * Represents an allocated external IP address and its corresponding internal * IP address in a private cloud. */ export interface ExternalAddress { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * User-provided description for this resource. */ description?: string; /** * Output only. The external IP address of a workload VM. */ readonly externalIp?: string; /** * The internal IP address of a workload VM. */ internalIp?: string; /** * Output only. Identifier. The resource name of this external IP address. * 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-address` */ readonly name?: string; /** * Output only. The state of the resource. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING" | "UPDATING" | "DELETING"; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; } /** * Response message for VmwareEngine.FetchNetworkPolicyExternalAddresses */ export interface FetchNetworkPolicyExternalAddressesResponse { /** * A list of external IP addresses assigned to VMware workload VMs within the * scope of the given network policy. */ externalAddresses?: ExternalAddress[]; /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; } /** * A forwarding rule is a mapping of a `domain` to `name_servers`. This mapping * allows VMware Engine to resolve domains for attached private clouds by * forwarding DNS requests for a given domain to the specified nameservers. */ export interface ForwardingRule { /** * Required. Domain used to resolve a `name_servers` list. */ domain?: string; /** * Required. List of DNS servers to use for domain resolution */ nameServers?: string[]; } /** * Request message for VmwareEngine.GrantDnsBindPermission */ export interface GrantDnsBindPermissionRequest { /** * Required. The consumer provided user/service account which needs to be * granted permission to bind with the intranet VPC corresponding to the * consumer project. */ principal?: 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). */ requestId?: string; } /** * Details about a HCX Cloud Manager appliance. */ export interface Hcx { /** * Fully qualified domain name of the appliance. */ fqdn?: string; /** * Internal IP address of the appliance. */ internalIp?: string; /** * Output only. The state of the appliance. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING" | "ACTIVATING"; /** * Version of the appliance. */ version?: string; } /** * HCX activation key. A default key is created during private cloud * provisioning, but this behavior is subject to change and you should always * verify active keys. Use VmwareEngine.ListHcxActivationKeys to retrieve * existing keys and VmwareEngine.CreateHcxActivationKey to create new ones. */ export interface HcxActivationKey { /** * Output only. HCX activation key. */ readonly activationKey?: string; /** * Output only. Creation time of HCX activation key. */ readonly createTime?: Date; /** * Output only. The resource name of this HcxActivationKey. 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` */ readonly name?: string; /** * Output only. State of HCX activation key. */ readonly state?: | "STATE_UNSPECIFIED" | "AVAILABLE" | "CONSUMED" | "CREATING"; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; } /** * An IP range provided in any one of the supported formats. */ export interface IpRange { /** * The name of an `ExternalAddress` resource. The external address must have * been reserved in the scope of this external access rule's parent network * policy. Provide the external address name in the form of * `projects/{project}/locations/{location}/privateClouds/{private_cloud}/externalAddresses/{external_address}`. * For example: * `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/externalAddresses/my-address`. */ externalAddress?: string; /** * A single IP address. For example: `10.0.0.5`. */ ipAddress?: string; /** * An IP address range in the CIDR format. For example: `10.0.0.0/24`. */ ipAddressRange?: string; } /** * Response message for VmwareEngine.ListClusters */ export interface ListClustersResponse { /** * A list of private cloud clusters. */ clusters?: Cluster[]; /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } function serializeListClustersResponse(data: any): ListClustersResponse { return { ...data, clusters: data["clusters"] !== undefined ? data["clusters"].map((item: any) => (serializeCluster(item))) : undefined, }; } function deserializeListClustersResponse(data: any): ListClustersResponse { return { ...data, clusters: data["clusters"] !== undefined ? data["clusters"].map((item: any) => (deserializeCluster(item))) : undefined, }; } /** * Response message for VmwareEngine.ListExternalAccessRules */ export interface ListExternalAccessRulesResponse { /** * A list of external access firewall rules. */ externalAccessRules?: ExternalAccessRule[]; /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListExternalAddresses */ export interface ListExternalAddressesResponse { /** * A list of external IP addresses. */ externalAddresses?: ExternalAddress[]; /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListHcxActivationKeys */ export interface ListHcxActivationKeysResponse { /** * List of HCX activation keys. */ hcxActivationKeys?: HcxActivationKey[]; /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * The response message for Locations.ListLocations. */ export interface ListLocationsResponse { /** * A list of locations that matches the specified filter in the request. */ locations?: Location[]; /** * The standard List next-page token. */ nextPageToken?: string; } /** * Response message for VmwareEngine.ListLoggingServers */ export interface ListLoggingServersResponse { /** * A list of Logging Servers. */ loggingServers?: LoggingServer[]; /** * A token, which can be send as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListManagementDnsZoneBindings */ export interface ListManagementDnsZoneBindingsResponse { /** * A list of management DNS zone bindings. */ managementDnsZoneBindings?: ManagementDnsZoneBinding[]; /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListNetworkPeerings */ export interface ListNetworkPeeringsResponse { /** * A list of network peerings. */ networkPeerings?: NetworkPeering[]; /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Unreachable resources. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListNetworkPolicies */ export interface ListNetworkPoliciesResponse { /** * A list of network policies. */ networkPolicies?: NetworkPolicy[]; /** * A token, which can be send as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListNodes */ export interface ListNodesResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * The nodes. */ nodes?: Node[]; } /** * Response message for VmwareEngine.ListNodeTypes */ export interface ListNodeTypesResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * A list of Node Types. */ nodeTypes?: NodeType[]; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * The response message for Operations.ListOperations. */ export interface ListOperationsResponse { /** * The standard List next-page token. */ nextPageToken?: string; /** * A list of operations that matches the specified filter in the request. */ operations?: Operation[]; } /** * Response message for VmwareEngine.ListPeeringRoutes */ export interface ListPeeringRoutesResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * A list of peering routes. */ peeringRoutes?: PeeringRoute[]; } /** * Response message for VmwareEngine.ListPrivateClouds */ export interface ListPrivateCloudsResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * A list of private clouds. */ privateClouds?: PrivateCloud[]; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListPrivateConnectionPeeringRoutes */ export interface ListPrivateConnectionPeeringRoutesResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * A list of peering routes. */ peeringRoutes?: PeeringRoute[]; } /** * Response message for VmwareEngine.ListPrivateConnections */ export interface ListPrivateConnectionsResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * A list of private connections. */ privateConnections?: PrivateConnection[]; /** * Unreachable resources. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListSubnets */ export interface ListSubnetsResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * A list of subnets. */ subnets?: Subnet[]; /** * Locations that could not be reached when making an aggregated query using * wildcards. */ unreachable?: string[]; } /** * Response message for VmwareEngine.ListVmwareEngineNetworks */ export interface ListVmwareEngineNetworksResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If * this field is omitted, there are no subsequent pages. */ nextPageToken?: string; /** * Unreachable resources. */ unreachable?: string[]; /** * A list of VMware Engine networks. */ vmwareEngineNetworks?: VmwareEngineNetwork[]; } /** * A resource that represents a Google Cloud location. */ export interface Location { /** * The friendly name for this location, typically a nearby city name. For * example, "Tokyo". */ displayName?: string; /** * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ labels?: { [key: string]: string }; /** * The canonical id for this location. For example: `"us-east1"`. */ locationId?: string; /** * Service-specific metadata. For example the available capacity at the given * location. */ metadata?: { [key: string]: any }; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` */ name?: string; } /** * VmwareEngine specific metadata for the given google.cloud.location.Location. * It is returned as a content of the `google.cloud.location.Location.metadata` * field. */ export interface LocationMetadata { /** * Output only. Capabilities of this location. */ readonly capabilities?: | "CAPABILITY_UNSPECIFIED" | "STRETCHED_CLUSTERS"[]; } /** * Logging server to receive vCenter or ESXi logs. */ export interface LoggingServer { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * Required. Fully-qualified domain name (FQDN) or IP Address of the logging * server. */ hostname?: string; /** * Output only. The resource name of this logging server. 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` */ readonly name?: string; /** * Required. Port number at which the logging server receives logs. */ port?: number; /** * Required. Protocol used by vCenter to send logs to a logging server. */ protocol?: | "PROTOCOL_UNSPECIFIED" | "UDP" | "TCP" | "TLS" | "SSL" | "RELP"; /** * Required. The type of component that produces logs that will be forwarded * to this logging server. */ sourceType?: | "SOURCE_TYPE_UNSPECIFIED" | "ESXI" | "VCSA"; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; } /** * Management cluster configuration. */ export interface ManagementCluster { /** * Required. The user-provided identifier of the new `Cluster`. 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) */ clusterId?: string; /** * Required. The map of cluster node types in this cluster, where the key is * canonical identifier of the node type (corresponds to the `NodeType`). */ nodeTypeConfigs?: { [key: string]: NodeTypeConfig }; /** * Optional. Configuration of a stretched cluster. Required for STRETCHED * private clouds. */ stretchedClusterConfig?: StretchedClusterConfig; } /** * Represents a binding between a network and 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. */ export interface ManagementDnsZoneBinding { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * User-provided description for this resource. */ description?: string; /** * Output only. The resource name of this binding. 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` */ readonly name?: string; /** * Output only. The state of the resource. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING" | "UPDATING" | "DELETING" | "FAILED"; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; /** * Network to bind is a VMware Engine network. Specify the name in the * following form for VMware engine network: * `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. * `{project}` can either be a project number or a project ID. */ vmwareEngineNetwork?: string; /** * Network to bind is a standard consumer VPC. Specify the name in the * following form for consumer VPC network: * `projects/{project}/global/networks/{network_id}`. `{project}` can either * be a project number or a project ID. */ vpcNetwork?: string; } /** * Network configuration in the consumer project with which the peering has to * be done. */ export interface NetworkConfig { /** * Output only. DNS Server IP of the Private Cloud. All DNS queries can be * forwarded to this address for name resolution of Private Cloud's management * entities like vCenter, NSX-T Manager and ESXi hosts. */ readonly dnsServerIp?: string; /** * Required. Management CIDR used by VMware management appliances. */ managementCidr?: string; /** * Output only. The IP address layout version of the management IP address * range. Possible versions include: * `managementIpAddressLayoutVersion=1`: * Indicates the legacy IP address layout used by some existing private * clouds. This is no longer supported for new private clouds as it does not * support all features. * `managementIpAddressLayoutVersion=2`: Indicates the * latest IP address layout used by all newly created private clouds. This * version supports all current features. */ readonly managementIpAddressLayoutVersion?: number; /** * Optional. The relative resource name of the VMware Engine network attached * to the private cloud. Specify the name in the following form: * `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` * where `{project}` can either be a project number or a project ID. */ vmwareEngineNetwork?: string; /** * Output only. The canonical name of the VMware Engine network in the form: * `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` */ readonly vmwareEngineNetworkCanonical?: string; } /** * Details of a network peering. */ export interface NetworkPeering { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * Optional. User-provided description for this network peering. */ description?: string; /** * Optional. True if full mesh connectivity is created and managed * automatically between peered networks; false otherwise. Currently this * field is always true because Google Compute Engine automatically creates * and manages subnetwork routes between two VPC networks when peering state * is 'ACTIVE'. */ exchangeSubnetRoutes?: boolean; /** * Optional. True if custom routes are exported to the peered network; false * otherwise. The default value is true. */ exportCustomRoutes?: boolean; /** * Optional. True if all subnet routes with a public IP address range are * exported; false otherwise. The default value is true. IPv4 special-use * ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always * exported to peers and are not controlled by this field. */ exportCustomRoutesWithPublicIp?: boolean; /** * Optional. True if custom routes are imported from the peered network; * false otherwise. The default value is true. */ importCustomRoutes?: boolean; /** * Optional. True if all subnet routes with public IP address range are * imported; false otherwise. The default value is true. IPv4 special-use * ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always * imported to peers and are not controlled by this field. */ importCustomRoutesWithPublicIp?: boolean; /** * Output only. Identifier. The resource name of the network peering. * NetworkPeering is a global resource and location can only be global. * Resource names are scheme-less URIs that follow the conventions in * https://cloud.google.com/apis/design/resource_names. For example: * `projects/my-project/locations/global/networkPeerings/my-peering` */ readonly name?: string; /** * Optional. Maximum transmission unit (MTU) in bytes. The default value is * `1500`. If a value of `0` is provided for this field, VMware Engine uses * the default value instead. */ peerMtu?: number; /** * Required. The relative resource name of the network to peer with a * standard VMware Engine network. The provided network can be a consumer VPC * network or another standard VMware Engine network. If the * `peer_network_type` is VMWARE_ENGINE_NETWORK, specify the name in the form: * `projects/{project}/locations/global/vmwareEngineNetworks/{vmware_engine_network_id}`. * Otherwise specify the name in the form: * `projects/{project}/global/networks/{network_id}`, where `{project}` can * either be a project number or a project ID. */ peerNetwork?: string; /** * Required. The type of the network to peer with the VMware Engine network. */ peerNetworkType?: | "PEER_NETWORK_TYPE_UNSPECIFIED" | "STANDARD" | "VMWARE_ENGINE_NETWORK" | "PRIVATE_SERVICES_ACCESS" | "NETAPP_CLOUD_VOLUMES" | "THIRD_PARTY_SERVICE" | "DELL_POWERSCALE" | "GOOGLE_CLOUD_NETAPP_VOLUMES"; /** * Output only. State of the network peering. This field has a value of * 'ACTIVE' when there's a matching configuration in the peer network. New * values may be added to this enum when appropriate. */ readonly state?: | "STATE_UNSPECIFIED" | "INACTIVE" | "ACTIVE" | "CREATING" | "DELETING"; /** * Output only. Output Only. Details about the current state of the network * peering. */ readonly stateDetails?: string; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; /** * Required. The relative resource name of the VMware Engine network. Specify * the name in the following form: * `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` * where `{project}` can either be a project number or a project ID. */ vmwareEngineNetwork?: string; } /** * Represents a network policy resource. Network policies are regional * resources. You can use a network policy to enable or disable internet access * and external IP access. Network policies are associated with a VMware Engine * network, which might span across regions. For a given region, a network * policy applies to all private clouds in the VMware Engine network associated * with the policy. */ export interface NetworkPolicy { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * Optional. User-provided description for this network policy. */ description?: string; /** * Required. IP address range in CIDR notation used to create internet access * and external IP access. An RFC 1918 CIDR block, with a "/26" prefix, is * required. The range cannot overlap with any prefixes either in the consumer * VPC network or in use by the private clouds attached to that VPC network. */ edgeServicesCidr?: string; /** * Network service that allows External IP addresses to be assigned to VMware * workloads. This service can only be enabled when `internet_access` is also * enabled. */ externalIp?: NetworkService; /** * Network service that allows VMware workloads to access the internet. */ internetAccess?: NetworkService; /** * Output only. Identifier. The resource name of this network policy. * 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` */ readonly name?: string; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; /** * Optional. The relative resource name of the VMware Engine network. Specify * the name in the following form: * `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` * where `{project}` can either be a project number or a project ID. */ vmwareEngineNetwork?: string; /** * Output only. The canonical name of the VMware Engine network in the form: * `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` */ readonly vmwareEngineNetworkCanonical?: string; } /** * Represents a network service that is managed by a `NetworkPolicy` resource. * A network service provides a way to control an aspect of external access to * VMware workloads. For example, whether the VMware workloads in the private * clouds governed by a network policy can access or be accessed from the * internet. */ export interface NetworkService { /** * True if the service is enabled; false otherwise. */ enabled?: boolean; /** * Output only. State of the service. New values may be added to this enum * when appropriate. */ readonly state?: | "STATE_UNSPECIFIED" | "UNPROVISIONED" | "RECONCILING" | "ACTIVE"; } /** * Node in a cluster. */ export interface Node { /** * Output only. Customized number of cores */ readonly customCoreCount?: bigint; /** * Output only. Fully qualified domain name of the node. */ readonly fqdn?: string; /** * Output only. Internal IP address of the node. */ readonly internalIp?: string; /** * Output only. The resource name of this node. 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/nodes/my-node */ readonly name?: string; /** * Output only. The canonical identifier of the node type (corresponds to the * `NodeType`). For example: standard-72. */ readonly nodeTypeId?: string; /** * Output only. The state of the appliance. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING" | "FAILED" | "UPGRADING"; /** * Output only. The version number of the VMware ESXi management component in * this cluster. */ readonly version?: string; } /** * Describes node type. */ export interface NodeType { /** * Output only. List of possible values of custom core count. */ readonly availableCustomCoreCounts?: number[]; /** * Output only. Capabilities of this node type. */ readonly capabilities?: | "CAPABILITY_UNSPECIFIED" | "STRETCHED_CLUSTERS"[]; /** * Output only. The amount of storage available, defined in GB. */ readonly diskSizeGb?: number; /** * Output only. The friendly name for this node type. For example: * ve1-standard-72 */ readonly displayName?: string; /** * Output only. Families of the node type. For node types to be in the same * cluster they must share at least one element in the `families`. */ readonly families?: string[]; /** * Output only. The type of the resource. */ readonly kind?: | "KIND_UNSPECIFIED" | "STANDARD" | "STORAGE_ONLY"; /** * Output only. The amount of physical memory available, defined in GB. */ readonly memoryGb?: number; /** * Output only. The resource name of this node type. 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` */ readonly name?: string; /** * Output only. The canonical identifier of the node type (corresponds to the * `NodeType`). For example: standard-72. */ readonly nodeTypeId?: string; /** * Output only. The total number of CPU cores in a single node. */ readonly totalCoreCount?: number; /** * Output only. The total number of virtual CPUs in a single node. */ readonly virtualCpuCount?: number; } /** * Information about the type and number of nodes associated with the cluster. */ export interface NodeTypeConfig { /** * Optional. Customized number of cores available to each node of the type. * This number must always be one of `nodeType.availableCustomCoreCounts`. If * zero is provided max value from `nodeType.availableCustomCoreCounts` will * be used. */ customCoreCount?: number; /** * Required. The number of nodes of this type in the cluster */ nodeCount?: number; } /** * Details about a NSX Manager appliance. */ export interface Nsx { /** * Fully qualified domain name of the appliance. */ fqdn?: string; /** * Internal IP address of the appliance. */ internalIp?: string; /** * Output only. The state of the appliance. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING"; /** * Version of the appliance. */ version?: string; } /** * This resource represents a long-running operation that is the result of a * network API call. */ export interface Operation { /** * If the value is `false`, it means the operation is still in progress. If * `true`, the operation is completed, and either `error` or `response` is * available. */ done?: boolean; /** * The error result of the operation in case of failure or cancellation. */ error?: Status; /** * Service-specific metadata associated with the operation. It typically * contains progress information and common metadata such as create time. Some * services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ metadata?: { [key: string]: any }; /** * The server-assigned name, which is only unique within the same service * that originally returns it. If you use the default HTTP mapping, the `name` * should be a resource name ending with `operations/{unique_id}`. */ name?: string; /** * The normal, successful response of the operation. If the original method * returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other * methods, the response should have the type `XxxResponse`, where `Xxx` is * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: { [key: string]: any }; } /** * Represents the metadata of the long-running operation. */ export interface OperationMetadata { /** * Output only. API version used to start the operation. */ readonly apiVersion?: string; /** * Output only. The time the operation was created. */ readonly createTime?: Date; /** * Output only. The time the operation finished running. */ readonly endTime?: Date; /** * Output only. True if the user has requested cancellation of the operation; * false otherwise. Operations that have successfully been cancelled have * Operation.error value with a google.rpc.Status.code of 1, corresponding to * `Code.CANCELLED`. */ readonly requestedCancellation?: boolean; /** * Output only. Human-readable status of the operation, if any. */ readonly statusMessage?: string; /** * Output only. Server-defined resource path for the target of the operation. */ readonly target?: string; /** * Output only. Name of the verb executed by the operation. */ readonly verb?: string; } /** * Exchanged network peering route. */ export interface PeeringRoute { /** * Output only. Destination range of the peering route in CIDR notation. */ readonly destRange?: string; /** * Output only. Direction of the routes exchanged with the peer network, from * the VMware Engine network perspective: * Routes of direction `INCOMING` are * imported from the peer network. * Routes of direction `OUTGOING` are * exported from the intranet VPC network of the VMware Engine network. */ readonly direction?: | "DIRECTION_UNSPECIFIED" | "INCOMING" | "OUTGOING"; /** * Output only. True if the peering route has been imported from a peered VPC * network; false otherwise. The import happens if the field * `NetworkPeering.importCustomRoutes` is true for this network, * `NetworkPeering.exportCustomRoutes` is true for the peer VPC network, and * the import does not result in a route conflict. */ readonly imported?: boolean; /** * Output only. Region containing the next hop of the peering route. This * field only applies to dynamic routes in the peer VPC network. */ readonly nextHopRegion?: string; /** * Output only. The priority of the peering route. */ readonly priority?: bigint; /** * Output only. Type of the route in the peer VPC network. */ readonly type?: | "TYPE_UNSPECIFIED" | "DYNAMIC_PEERING_ROUTE" | "STATIC_PEERING_ROUTE" | "SUBNET_PEERING_ROUTE"; } /** * An Identity and Access Management (IAM) policy, which specifies access * controls for Google Cloud resources. A `Policy` is a collection of * `bindings`. A `binding` binds one or more `members`, or principals, to a * single `role`. Principals can be user accounts, service accounts, Google * groups, and domains (such as G Suite). A `role` is a named list of * permissions; each `role` can be an IAM predefined role or a user-created * custom role. For some types of Google Cloud resources, a `binding` can also * specify a `condition`, which is a logical expression that allows access to a * resource only if the expression evaluates to `true`. A condition can add * constraints based on attributes of the request, the resource, or both. To * learn which resources support conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). * **JSON example:** ``` { "bindings": [ { "role": * "roles/resourcemanager.organizationAdmin", "members": [ * "user:mike@example.com", "group:admins@example.com", "domain:google.com", * "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": * "roles/resourcemanager.organizationViewer", "members": [ * "user:eve@example.com" ], "condition": { "title": "expirable access", * "description": "Does not grant access after Sep 2020", "expression": * "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": * "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: * - user:mike@example.com - group:admins@example.com - domain:google.com - * serviceAccount:my-project-id@appspot.gserviceaccount.com role: * roles/resourcemanager.organizationAdmin - members: - user:eve@example.com * role: roles/resourcemanager.organizationViewer condition: title: expirable * access description: Does not grant access after Sep 2020 expression: * request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= * version: 3 ``` For a description of IAM and its features, see the [IAM * documentation](https://cloud.google.com/iam/docs/). */ export interface Policy { /** * Specifies cloud audit logging configuration for this policy. */ auditConfigs?: AuditConfig[]; /** * Associates a list of `members`, or principals, with a `role`. Optionally, * may specify a `condition` that determines how and when the `bindings` are * applied. Each of the `bindings` must contain at least one principal. The * `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of * these principals can be Google groups. Each occurrence of a principal * counts towards these limits. For example, if the `bindings` grant 50 * different roles to `user:alice@example.com`, and not to any other * principal, then you can add another 1,450 principals to the `bindings` in * the `Policy`. */ bindings?: Binding[]; /** * `etag` is used for optimistic concurrency control as a way to help prevent * simultaneous updates of a policy from overwriting each other. It is * strongly suggested that systems make use of the `etag` in the * read-modify-write cycle to perform policy updates in order to avoid race * conditions: An `etag` is returned in the response to `getIamPolicy`, and * systems are expected to put that etag in the request to `setIamPolicy` to * ensure that their change will be applied to the same version of the policy. * **Important:** If you use IAM Conditions, you must include the `etag` field * whenever you call `setIamPolicy`. If you omit this field, then IAM allows * you to overwrite a version `3` policy with a version `1` policy, and all of * the conditions in the version `3` policy are lost. */ etag?: Uint8Array; /** * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. * Requests that specify an invalid value are rejected. Any operation that * affects conditional role bindings must specify version `3`. This * requirement applies to the following operations: * Getting a policy that * includes a conditional role binding * Adding a conditional role binding to * a policy * Changing a conditional role binding in a policy * Removing any * role binding, with or without a condition, from a policy that includes * conditions **Important:** If you use IAM Conditions, you must include the * `etag` field whenever you call `setIamPolicy`. If you omit this field, then * IAM allows you to overwrite a version `3` policy with a version `1` policy, * and all of the conditions in the version `3` policy are lost. If a policy * does not include any conditions, operations on that policy may specify any * valid version or leave the field unset. To learn which resources support * conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ version?: number; } function serializePolicy(data: any): Policy { return { ...data, etag: data["etag"] !== undefined ? encodeBase64(data["etag"]) : undefined, }; } function deserializePolicy(data: any): Policy { return { ...data, etag: data["etag"] !== undefined ? decodeBase64(data["etag"] as string) : undefined, }; } /** * Users/Service accounts which have access for DNS binding on the intranet VPC * corresponding to the consumer project. */ export interface Principal { /** * The service account which needs to be granted the permission. */ serviceAccount?: string; /** * The user who needs to be granted permission. */ user?: string; } /** * Represents a private cloud resource. Private clouds of type `STANDARD` and * `TIME_LIMITED` are zonal resources, `STRETCHED` private clouds are regional. */ export interface PrivateCloud { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * Output only. Time when the resource was scheduled for deletion. */ readonly deleteTime?: Date; /** * User-provided description for this private cloud. */ description?: string; /** * Output only. Time when the resource will be irreversibly deleted. */ readonly expireTime?: Date; /** * Output only. HCX appliance. */ readonly hcx?: Hcx; /** * Required. Input only. The management cluster for this private cloud. This * field is required during creation of the private cloud to provide details * for the default cluster. The following fields can't be changed after * private cloud creation: `ManagementCluster.clusterId`, * `ManagementCluster.nodeTypeId`. */ managementCluster?: ManagementCluster; /** * Output only. Identifier. The resource name of this private cloud. 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` */ readonly name?: string; /** * Required. Network configuration of the private cloud. */ networkConfig?: NetworkConfig; /** * Output only. NSX appliance. */ readonly nsx?: Nsx; /** * Output only. State of the resource. New values may be added to this enum * when appropriate. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING" | "UPDATING" | "FAILED" | "DELETED" | "PURGING"; /** * Optional. Type of the private cloud. Defaults to STANDARD. */ type?: | "STANDARD" | "TIME_LIMITED" | "STRETCHED"; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; /** * Output only. Vcenter appliance. */ readonly vcenter?: Vcenter; } /** * Private connection resource that provides connectivity for VMware Engine * private clouds. */ export interface PrivateConnection { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * Optional. User-provided description for this private connection. */ description?: string; /** * Output only. The resource name of the private connection. 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` */ readonly name?: string; /** * Output only. VPC network peering id between given network VPC and * VMwareEngineNetwork. */ readonly peeringId?: string; /** * Output only. Peering state between service network and VMware Engine * network. */ readonly peeringState?: | "PEERING_STATE_UNSPECIFIED" | "PEERING_ACTIVE" | "PEERING_INACTIVE"; /** * Optional. Routing Mode. Default value is set to GLOBAL. For type = * PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for * other types only GLOBAL is supported. */ routingMode?: | "ROUTING_MODE_UNSPECIFIED" | "GLOBAL" | "REGIONAL"; /** * Required. Service network to create private connection. Specify the name * in the following form: `projects/{project}/global/networks/{network_id}` * For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking * VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = * NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. * projects/project-tp/global/networks/netapp-tenant-vpc. For type = * DELL_POWERSCALE, this field represent Dell service VPC, e.g. * projects/project-tp/global/networks/dell-tenant-vpc. For type= * THIRD_PARTY_SERVICE, this field could represent a consumer VPC or any other * producer VPC to which the VMware Engine Network needs to be connected, e.g. * projects/project/global/networks/vpc. */ serviceNetwork?: string; /** * Output only. State of the private connection. */ readonly state?: | "STATE_UNSPECIFIED" | "CREATING" | "ACTIVE" | "UPDATING" | "DELETING" | "UNPROVISIONED" | "FAILED"; /** * Required. Private connection type. */ type?: | "TYPE_UNSPECIFIED" | "PRIVATE_SERVICE_ACCESS" | "NETAPP_CLOUD_VOLUMES" | "DELL_POWERSCALE" | "THIRD_PARTY_SERVICE"; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; /** * Required. The relative resource name of Legacy VMware Engine network. * Specify the name in the following form: * `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` * where `{project}`, `{location}` will be same as specified in private * connection resource name and `{vmware_engine_network_id}` will be in the * form of `{location}`-default e.g. * projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default. */ vmwareEngineNetwork?: string; /** * Output only. The canonical name of the VMware Engine network in the form: * `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` */ readonly vmwareEngineNetworkCanonical?: string; } /** * Additional options for VMwareEngine#projectsLocationsList. */ export interface ProjectsLocationsListOptions { /** * A filter to narrow down results to a preferred subset. The filtering * language accepts strings like `"displayName=tokyo"`, and is documented in * more detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** * The maximum number of results to return. If not set, the service selects a * default. */ pageSize?: number; /** * A page token received from the `next_page_token` field in the response. * Send that page token to receive the subsequent page. */ pageToken?: string; } /** * Additional options for VMwareEngine#projectsLocationsNetworkPeeringsCreate. */ export interface ProjectsLocationsNetworkPeeringsCreateOptions { /** * 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) */ networkPeeringId?: string; /** * 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). */ requestId?: string; } /** * Additional options for VMwareEngine#projectsLocationsNetworkPeeringsDelete. */ export interface ProjectsLocationsNetworkPeeringsDeleteOptions { /** * 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). */ requestId?: string; } /** * Additional options for VMwareEngine#projectsLocationsNetworkPeeringsList. */ export interface ProjectsLocationsNetworkPeeringsListOptions { /** * 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` and * `OR` expressions explicitly. For example: ``` (name = "example-peering-1") * AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = * "example-peering-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for VMwareEngine#projectsLocationsNetworkPeeringsPatch. */ export interface ProjectsLocationsNetworkPeeringsPatchOptions { /** * 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). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsNetworkPeeringsPatchOptions(data: any): ProjectsLocationsNetworkPeeringsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsNetworkPeeringsPatchOptions(data: any): ProjectsLocationsNetworkPeeringsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for * VMwareEngine#projectsLocationsNetworkPeeringsPeeringRoutesList. */ export interface ProjectsLocationsNetworkPeeringsPeeringRoutesListOptions { /** * 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. */ filter?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for VMwareEngine#projectsLocationsNetworkPoliciesCreate. */ export interface ProjectsLocationsNetworkPoliciesCreateOptions { /** * 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) */ networkPolicyId?: string; /** * 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). */ requestId?: string; } /** * Additional options for VMwareEngine#projectsLocationsNetworkPoliciesDelete. */ export interface ProjectsLocationsNetworkPoliciesDeleteOptions { /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsNetworkPoliciesExternalAccessRulesCreate. */ export interface ProjectsLocationsNetworkPoliciesExternalAccessRulesCreateOptions { /** * 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) */ externalAccessRuleId?: string; /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsNetworkPoliciesExternalAccessRulesDelete. */ export interface ProjectsLocationsNetworkPoliciesExternalAccessRulesDeleteOptions { /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsNetworkPoliciesExternalAccessRulesList. */ export interface ProjectsLocationsNetworkPoliciesExternalAccessRulesListOptions { /** * 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` and `OR` expressions * explicitly. For example: ``` (name = "example-rule-1") AND (createTime > * "2021-04-12T08:15:10.40Z") OR (name = "example-rule-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsNetworkPoliciesExternalAccessRulesPatch. */ export interface ProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions { /** * 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). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions(data: any): ProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions(data: any): ProjectsLocationsNetworkPoliciesExternalAccessRulesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for * VMwareEngine#projectsLocationsNetworkPoliciesFetchExternalAddresses. */ export interface ProjectsLocationsNetworkPoliciesFetchExternalAddressesOptions { /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for VMwareEngine#projectsLocationsNetworkPoliciesList. */ export interface ProjectsLocationsNetworkPoliciesListOptions { /** * 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` and `OR` expressions * explicitly. For example: ``` (name = "example-policy-1") AND (createTime > * "2021-04-12T08:15:10.40Z") OR (name = "example-policy-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for VMwareEngine#projectsLocationsNetworkPoliciesPatch. */ export interface ProjectsLocationsNetworkPoliciesPatchOptions { /** * 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). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsNetworkPoliciesPatchOptions(data: any): ProjectsLocationsNetworkPoliciesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsNetworkPoliciesPatchOptions(data: any): ProjectsLocationsNetworkPoliciesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for VMwareEngine#projectsLocationsNodeTypesList. */ export interface ProjectsLocationsNodeTypesListOptions { /** * 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` and `OR` expressions explicitly. For example: ``` (name = * "standard-96") AND (virtual_cpu_count > 2) OR (name = "standard-72") ``` */ filter?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for VMwareEngine#projectsLocationsOperationsList. */ export interface ProjectsLocationsOperationsListOptions { /** * The standard list filter. */ filter?: string; /** * The standard list page size. */ pageSize?: number; /** * The standard list page token. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsClustersCreate. */ export interface ProjectsLocationsPrivateCloudsClustersCreateOptions { /** * 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) */ clusterId?: string; /** * Optional. The request ID must be a valid UUID with the exception that zero * UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Optional. True if you want the request to be validated and not executed; * false otherwise. */ validateOnly?: boolean; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsClustersDelete. */ export interface ProjectsLocationsPrivateCloudsClustersDeleteOptions { /** * Optional. The request ID must be a valid UUID with the exception that zero * UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsClustersGetIamPolicy. */ export interface ProjectsLocationsPrivateCloudsClustersGetIamPolicyOptions { /** * Optional. The maximum policy version that will be used to format the * policy. Valid values are 0, 1, and 3. Requests specifying an invalid value * will be rejected. Requests for policies with any conditional role bindings * must specify version 3. Policies with no conditional role bindings may * specify any valid value or leave the field unset. The policy in the * response might use the policy version that you specified, or it might use a * lower policy version. For example, if you specify version 3, but the policy * has no conditional role bindings, the response uses version 1. To learn * which resources support conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ ["options.requestedPolicyVersion"]?: number; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsClustersList. */ export interface ProjectsLocationsPrivateCloudsClustersListOptions { /** * 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` and `OR` expressions explicitly. For example: ``` (name = * "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name * = "example-cluster-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsClustersNodesList. */ export interface ProjectsLocationsPrivateCloudsClustersNodesListOptions { /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsClustersPatch. */ export interface ProjectsLocationsPrivateCloudsClustersPatchOptions { /** * Optional. The request ID must be a valid UUID with the exception that zero * UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; /** * Optional. True if you want the request to be validated and not executed; * false otherwise. */ validateOnly?: boolean; } function serializeProjectsLocationsPrivateCloudsClustersPatchOptions(data: any): ProjectsLocationsPrivateCloudsClustersPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsPrivateCloudsClustersPatchOptions(data: any): ProjectsLocationsPrivateCloudsClustersPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for VMwareEngine#projectsLocationsPrivateCloudsCreate. */ export interface ProjectsLocationsPrivateCloudsCreateOptions { /** * 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) */ privateCloudId?: string; /** * Optional. The request ID must be a valid UUID with the exception that zero * UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * Optional. True if you want the request to be validated and not executed; * false otherwise. */ validateOnly?: boolean; } /** * Additional options for VMwareEngine#projectsLocationsPrivateCloudsDelete. */ export interface ProjectsLocationsPrivateCloudsDeleteOptions { /** * 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. 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`. */ delayHours?: number; /** * 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. */ force?: boolean; /** * Optional. The request ID must be a valid UUID with the exception that zero * UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsExternalAddressesCreate. */ export interface ProjectsLocationsPrivateCloudsExternalAddressesCreateOptions { /** * 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) */ externalAddressId?: string; /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsExternalAddressesDelete. */ export interface ProjectsLocationsPrivateCloudsExternalAddressesDeleteOptions { /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsExternalAddressesList. */ export interface ProjectsLocationsPrivateCloudsExternalAddressesListOptions { /** * 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` and `OR` expressions explicitly. * For example: ``` (name = "example-ip-1") AND (createTime > * "2021-04-12T08:15:10.40Z") OR (name = "example-ip-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsExternalAddressesPatch. */ export interface ProjectsLocationsPrivateCloudsExternalAddressesPatchOptions { /** * 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). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsPrivateCloudsExternalAddressesPatchOptions(data: any): ProjectsLocationsPrivateCloudsExternalAddressesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsPrivateCloudsExternalAddressesPatchOptions(data: any): ProjectsLocationsPrivateCloudsExternalAddressesPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsGetIamPolicy. */ export interface ProjectsLocationsPrivateCloudsGetIamPolicyOptions { /** * Optional. The maximum policy version that will be used to format the * policy. Valid values are 0, 1, and 3. Requests specifying an invalid value * will be rejected. Requests for policies with any conditional role bindings * must specify version 3. Policies with no conditional role bindings may * specify any valid value or leave the field unset. The policy in the * response might use the policy version that you specified, or it might use a * lower policy version. For example, if you specify version 3, but the policy * has no conditional role bindings, the response uses version 1. To learn * which resources support conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ ["options.requestedPolicyVersion"]?: number; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsHcxActivationKeysCreate. */ export interface ProjectsLocationsPrivateCloudsHcxActivationKeysCreateOptions { /** * 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) */ hcxActivationKeyId?: string; /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsHcxActivationKeysGetIamPolicy. */ export interface ProjectsLocationsPrivateCloudsHcxActivationKeysGetIamPolicyOptions { /** * Optional. The maximum policy version that will be used to format the * policy. Valid values are 0, 1, and 3. Requests specifying an invalid value * will be rejected. Requests for policies with any conditional role bindings * must specify version 3. Policies with no conditional role bindings may * specify any valid value or leave the field unset. The policy in the * response might use the policy version that you specified, or it might use a * lower policy version. For example, if you specify version 3, but the policy * has no conditional role bindings, the response uses version 1. To learn * which resources support conditions in their IAM policies, see the [IAM * documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */ ["options.requestedPolicyVersion"]?: number; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsHcxActivationKeysList. */ export interface ProjectsLocationsPrivateCloudsHcxActivationKeysListOptions { /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for VMwareEngine#projectsLocationsPrivateCloudsList. */ export interface ProjectsLocationsPrivateCloudsListOptions { /** * 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` and `OR` expressions explicitly. * For example: ``` (name = "private-cloud-1") AND (createTime > * "2021-04-12T08:15:10.40Z") OR (name = "private-cloud-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsLoggingServersCreate. */ export interface ProjectsLocationsPrivateCloudsLoggingServersCreateOptions { /** * 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) */ loggingServerId?: string; /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsLoggingServersDelete. */ export interface ProjectsLocationsPrivateCloudsLoggingServersDeleteOptions { /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsLoggingServersList. */ export interface ProjectsLocationsPrivateCloudsLoggingServersListOptions { /** * 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` and `OR` expressions * explicitly. For example: ``` (name = "example-server-1") AND (createTime > * "2021-04-12T08:15:10.40Z") OR (name = "example-server-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsLoggingServersPatch. */ export interface ProjectsLocationsPrivateCloudsLoggingServersPatchOptions { /** * 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). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsPrivateCloudsLoggingServersPatchOptions(data: any): ProjectsLocationsPrivateCloudsLoggingServersPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsPrivateCloudsLoggingServersPatchOptions(data: any): ProjectsLocationsPrivateCloudsLoggingServersPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsManagementDnsZoneBindingsCreate. */ export interface ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsCreateOptions { /** * 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) */ managementDnsZoneBindingId?: string; /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsManagementDnsZoneBindingsDelete. */ export interface ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsDeleteOptions { /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsManagementDnsZoneBindingsList. */ export interface ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsListOptions { /** * 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` and `OR` 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") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsManagementDnsZoneBindingsPatch. */ export interface ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions { /** * 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). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions(data: any): ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions(data: any): ProjectsLocationsPrivateCloudsManagementDnsZoneBindingsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for VMwareEngine#projectsLocationsPrivateCloudsPatch. */ export interface ProjectsLocationsPrivateCloudsPatchOptions { /** * Optional. The request ID must be a valid UUID with the exception that zero * UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsPrivateCloudsPatchOptions(data: any): ProjectsLocationsPrivateCloudsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsPrivateCloudsPatchOptions(data: any): ProjectsLocationsPrivateCloudsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsShowVcenterCredentials. */ export interface ProjectsLocationsPrivateCloudsShowVcenterCredentialsOptions { /** * 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. */ username?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsSubnetsList. */ export interface ProjectsLocationsPrivateCloudsSubnetsListOptions { /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsSubnetsPatch. */ export interface ProjectsLocationsPrivateCloudsSubnetsPatchOptions { /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsPrivateCloudsSubnetsPatchOptions(data: any): ProjectsLocationsPrivateCloudsSubnetsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsPrivateCloudsSubnetsPatchOptions(data: any): ProjectsLocationsPrivateCloudsSubnetsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateCloudsUpdateDnsForwarding. */ export interface ProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions { /** * 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). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions(data: any): ProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions(data: any): ProjectsLocationsPrivateCloudsUpdateDnsForwardingOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateConnectionsCreate. */ export interface ProjectsLocationsPrivateConnectionsCreateOptions { /** * 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) */ privateConnectionId?: string; /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateConnectionsDelete. */ export interface ProjectsLocationsPrivateConnectionsDeleteOptions { /** * 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). */ requestId?: string; } /** * Additional options for VMwareEngine#projectsLocationsPrivateConnectionsList. */ export interface ProjectsLocationsPrivateConnectionsListOptions { /** * 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` and `OR` expressions explicitly. For example: ``` (name = * "example-connection-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR * (name = "example-connection-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateConnectionsPatch. */ export interface ProjectsLocationsPrivateConnectionsPatchOptions { /** * 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). */ requestId?: string; /** * 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. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsPrivateConnectionsPatchOptions(data: any): ProjectsLocationsPrivateConnectionsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsPrivateConnectionsPatchOptions(data: any): ProjectsLocationsPrivateConnectionsPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Additional options for * VMwareEngine#projectsLocationsPrivateConnectionsPeeringRoutesList. */ export interface ProjectsLocationsPrivateConnectionsPeeringRoutesListOptions { /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsVmwareEngineNetworksCreate. */ export interface ProjectsLocationsVmwareEngineNetworksCreateOptions { /** * 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). */ requestId?: string; /** * 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) */ vmwareEngineNetworkId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsVmwareEngineNetworksDelete. */ export interface ProjectsLocationsVmwareEngineNetworksDeleteOptions { /** * 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. */ etag?: string; /** * 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). */ requestId?: string; } /** * Additional options for * VMwareEngine#projectsLocationsVmwareEngineNetworksList. */ export interface ProjectsLocationsVmwareEngineNetworksListOptions { /** * 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` and * `OR` expressions explicitly. For example: ``` (name = "example-network-1") * AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = * "example-network-2") ``` */ filter?: string; /** * 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. */ orderBy?: string; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; } /** * Additional options for * VMwareEngine#projectsLocationsVmwareEngineNetworksPatch. */ export interface ProjectsLocationsVmwareEngineNetworksPatchOptions { /** * 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). */ requestId?: string; /** * 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`. */ updateMask?: string /* FieldMask */; } function serializeProjectsLocationsVmwareEngineNetworksPatchOptions(data: any): ProjectsLocationsVmwareEngineNetworksPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeProjectsLocationsVmwareEngineNetworksPatchOptions(data: any): ProjectsLocationsVmwareEngineNetworksPatchOptions { return { ...data, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * Request message for VmwareEngine.RepairManagementDnsZoneBindings */ export interface RepairManagementDnsZoneBindingRequest { /** * 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). */ requestId?: string; } /** * Request message for VmwareEngine.ResetNsxCredentials */ export interface ResetNsxCredentialsRequest { /** * 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). */ requestId?: string; } /** * Request message for VmwareEngine.ResetVcenterCredentials */ export interface ResetVcenterCredentialsRequest { /** * 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). */ requestId?: string; /** * 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. */ username?: string; } /** * Request message for VmwareEngine.RevokeDnsBindPermission */ export interface RevokeDnsBindPermissionRequest { /** * Required. The consumer provided user/service account which needs to be * granted permission to bind with the intranet VPC corresponding to the * consumer project. */ principal?: 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). */ requestId?: string; } /** * Request message for `SetIamPolicy` method. */ export interface SetIamPolicyRequest { /** * REQUIRED: The complete policy to be applied to the `resource`. The size of * the policy is limited to a few 10s of KB. An empty policy is a valid policy * but certain Google Cloud services (such as Projects) might reject them. */ policy?: Policy; /** * OPTIONAL: A FieldMask specifying which fields of the policy to modify. * Only the fields in the mask will be modified. If no mask is provided, the * following default mask is used: `paths: "bindings, etag"` */ updateMask?: string /* FieldMask */; } function serializeSetIamPolicyRequest(data: any): SetIamPolicyRequest { return { ...data, policy: data["policy"] !== undefined ? serializePolicy(data["policy"]) : undefined, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } function deserializeSetIamPolicyRequest(data: any): SetIamPolicyRequest { return { ...data, policy: data["policy"] !== undefined ? deserializePolicy(data["policy"]) : undefined, updateMask: data["updateMask"] !== undefined ? data["updateMask"] : undefined, }; } /** * The `Status` type defines a logical error model that is suitable for * different programming environments, including REST APIs and RPC APIs. It is * used by [gRPC](https://github.com/grpc). Each `Status` message contains three * pieces of data: error code, error message, and error details. You can find * out more about this error model and how to work with it in the [API Design * Guide](https://cloud.google.com/apis/design/errors). */ export interface Status { /** * The status code, which should be an enum value of google.rpc.Code. */ code?: number; /** * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ details?: { [key: string]: any }[]; /** * A developer-facing error message, which should be in English. Any * user-facing error message should be localized and sent in the * google.rpc.Status.details field, or localized by the client. */ message?: string; } /** * Configuration of a stretched cluster. */ export interface StretchedClusterConfig { /** * Required. Zone that will remain operational when connection between the * two zones is lost. Specify the resource name of a zone that belongs to the * region of the private cloud. For example: * `projects/{project}/locations/europe-west3-a` where `{project}` can either * be a project number or a project ID. */ preferredLocation?: string; /** * Required. Additional zone for a higher level of availability and load * balancing. Specify the resource name of a zone that belongs to the region * of the private cloud. For example: * `projects/{project}/locations/europe-west3-b` where `{project}` can either * be a project number or a project ID. */ secondaryLocation?: string; } /** * Subnet in a private cloud. Either `management` subnets (such as vMotion) * that are read-only, or `userDefined`, which can also be updated. */ export interface Subnet { /** * The IP address of the gateway of this subnet. Must fall within the IP * prefix defined above. */ gatewayIp?: string; /** * The IP address range of the subnet in CIDR format '10.0.0.0/24'. */ ipCidrRange?: string; /** * Output only. Identifier. The resource name of this subnet. 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` */ readonly name?: string; /** * Output only. The state of the resource. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING" | "UPDATING" | "DELETING" | "RECONCILING" | "FAILED"; /** * Output only. The type of the subnet. For example "management" or * "userDefined". */ readonly type?: string; /** * Output only. VLAN ID of the VLAN on which the subnet is configured */ readonly vlanId?: number; } /** * Request message for `TestIamPermissions` method. */ export interface TestIamPermissionsRequest { /** * The set of permissions to check for the `resource`. Permissions with * wildcards (such as `*` or `storage.*`) are not allowed. For more * information see [IAM * Overview](https://cloud.google.com/iam/docs/overview#permissions). */ permissions?: string[]; } /** * Response message for `TestIamPermissions` method. */ export interface TestIamPermissionsResponse { /** * A subset of `TestPermissionsRequest.permissions` that the caller is * allowed. */ permissions?: string[]; } /** * Thresholds define the utilization of resources triggering scale-out and * scale-in operations. */ export interface Thresholds { /** * Required. The utilization triggering the scale-in operation in percent. */ scaleIn?: number; /** * Required. The utilization triggering the scale-out operation in percent. */ scaleOut?: number; } /** * Request message for VmwareEngine.UndeletePrivateCloud */ export interface UndeletePrivateCloudRequest { /** * Optional. The request ID must be a valid UUID with the exception that zero * UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } /** * Details about a vCenter Server management appliance. */ export interface Vcenter { /** * Fully qualified domain name of the appliance. */ fqdn?: string; /** * Internal IP address of the appliance. */ internalIp?: string; /** * Output only. The state of the appliance. */ readonly state?: | "STATE_UNSPECIFIED" | "ACTIVE" | "CREATING"; /** * Version of the appliance. */ version?: string; } /** * VMware Engine network resource that provides connectivity for VMware Engine * private clouds. */ export interface VmwareEngineNetwork { /** * Output only. Creation time of this resource. */ readonly createTime?: Date; /** * User-provided description for this VMware Engine network. */ description?: string; /** * Checksum that may be sent on update and delete requests to ensure that the * user-provided value is up to date before the server processes a request. * The server computes checksums based on the value of other fields in the * request. */ etag?: string; /** * Output only. Identifier. The resource name of the VMware Engine network. * 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` */ readonly name?: string; /** * Output only. State of the VMware Engine network. */ readonly state?: | "STATE_UNSPECIFIED" | "CREATING" | "ACTIVE" | "UPDATING" | "DELETING"; /** * Required. VMware Engine network type. */ type?: | "TYPE_UNSPECIFIED" | "LEGACY" | "STANDARD"; /** * Output only. System-generated unique identifier for the resource. */ readonly uid?: string; /** * Output only. Last update time of this resource. */ readonly updateTime?: Date; /** * Output only. VMware Engine service VPC networks that provide connectivity * from a private cloud to customer projects, the internet, and other Google * Cloud services. */ readonly vpcNetworks?: VpcNetwork[]; } /** * Represents a VMware Engine VPC network that is managed by a VMware Engine * network resource. */ export interface VpcNetwork { /** * Output only. The relative resource name of the service VPC network this * VMware Engine network is attached to. For example: * `projects/123123/global/networks/my-network` */ readonly network?: string; /** * Output only. Type of VPC network (INTRANET, INTERNET, or GOOGLE_CLOUD) */ readonly type?: | "TYPE_UNSPECIFIED" | "INTRANET" | "INTERNET" | "GOOGLE_CLOUD"; } function decodeBase64(b64: string): Uint8Array { const binString = atob(b64); const size = binString.length; const bytes = new Uint8Array(size); for (let i = 0; i < size; i++) { bytes[i] = binString.charCodeAt(i); } return bytes; } const base64abc = ["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z","a","b","c","d","e","f","g","h","i","j","k","l","m","n","o","p","q","r","s","t","u","v","w","x","y","z","0","1","2","3","4","5","6","7","8","9","+","/"]; /** * CREDIT: https://gist.github.com/enepomnyaschih/72c423f727d395eeaa09697058238727 * Encodes a given Uint8Array, ArrayBuffer or string into RFC4648 base64 representation * @param data */ function encodeBase64(uint8: Uint8Array): string { let result = "", i; const l = uint8.length; for (i = 2; i < l; i += 3) { result += base64abc[uint8[i - 2] >> 2]; result += base64abc[((uint8[i - 2] & 0x03) << 4) | (uint8[i - 1] >> 4)]; result += base64abc[((uint8[i - 1] & 0x0f) << 2) | (uint8[i] >> 6)]; result += base64abc[uint8[i] & 0x3f]; } if (i === l + 1) { // 1 octet yet to write result += base64abc[uint8[i - 2] >> 2]; result += base64abc[(uint8[i - 2] & 0x03) << 4]; result += "=="; } if (i === l) { // 2 octets yet to write result += base64abc[uint8[i - 2] >> 2]; result += base64abc[((uint8[i - 2] & 0x03) << 4) | (uint8[i - 1] >> 4)]; result += base64abc[(uint8[i - 1] & 0x0f) << 2]; result += "="; } return result; }