2023-09-30
▼ ▲ vmwareengine.projects.locations.privateClouds.hcxActivationKeys.getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:getIamPolicy
Parameter Order: resource
HTTP Method: GET
Parameters:
resource
Location: path
Description: 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.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/hcxActivationKeys/[^/]+$
Required: Yes
options.requestedPolicyVersion
Location: query
Type: integer
Description: 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).
Format: int32
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ vmwareengine.projects.locations.privateClouds.hcxActivationKeys.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys
Path: v1/{+parent}/hcxActivationKeys
HTTP Method: GET
Description: Lists `HcxActivationKey` resources in a given private cloud.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
pageSize
Type: integer
Description: 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.
Format: int32
Location: query
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Required: Yes
Location: path
Description: 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`
pageToken
Location: query
Description: 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.
Type: string
▼ ▲ vmwareengine.projects.locations.privateClouds.hcxActivationKeys.create
Path: v1/{+parent}/hcxActivationKeys
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys
Description: Creates a new HCX activation key in a given private cloud.
Parameters:
requestId
Description: 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).
Type: string
Location: query
hcxActivationKeyId
Type: string
Location: query
Description: 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)
parent
Required: Yes
Description: 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`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ vmwareengine.projects.locations.privateClouds.hcxActivationKeys.testIamPermissions
Parameters:
resource
Location: path
Description: 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.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/hcxActivationKeys/[^/]+$
Required: Yes
Path: v1/{+resource}:testIamPermissions
HTTP Method: POST
Description: 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.
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:testIamPermissions
▼ ▲ vmwareengine.projects.locations.privateClouds.hcxActivationKeys.get
Path: v1/{+name}
HTTP Method: GET
Description: Retrieves a `HcxActivationKey` resource by its resource name.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}
Parameters:
name
Required: Yes
Type: string
Description: 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`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/hcxActivationKeys/[^/]+$
Parameter Order: name
▼ ▲ vmwareengine.projects.locations.privateClouds.hcxActivationKeys.setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:setIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Description: 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.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/hcxActivationKeys/[^/]+$
Type: string
Location: path
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1/{+resource}:setIamPolicy
HTTP Method: POST
▼ ▲ vmwareengine.projects.locations.privateClouds.subnets.list
HTTP Method: GET
Parameters:
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Description: 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`
Type: string
Required: Yes
pageSize
Description: 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.
Location: query
Type: integer
Format: int32
pageToken
Location: query
Type: string
Description: 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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/subnets
Path: v1/{+parent}/subnets
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists subnets in a given private cloud.
Parameter Order: parent
▼ ▲ vmwareengine.projects.locations.privateClouds.subnets.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: 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`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/subnets/[^/]+$
Type: string
Location: path
Description: Gets details of a single subnet.
HTTP Method: GET
Parameter Order: name
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/subnets/{subnetsId}
▼ ▲ vmwareengine.projects.locations.privateClouds.subnets.patch
Parameter Order: name
Description: 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.
HTTP Method: PATCH
Parameters:
updateMask
Location: query
Description: 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.
Format: google-fieldmask
Type: string
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/subnets/[^/]+$
Type: string
Location: path
Description: Output only. 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`
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/subnets/{subnetsId}
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.list
Parameters:
pageToken
Type: string
Description: 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.
Location: query
pageSize
Format: int32
Description: 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.
Type: integer
Location: query
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Description: 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`
orderBy
Description: 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.
Location: query
Type: string
filter
Description: 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") ```
Type: string
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters
Description: Lists `Cluster` resources in a given private cloud.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+parent}/clusters
Parameter Order: parent
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.delete
HTTP Method: DELETE
Parameters:
requestId
Description: Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$
Description: 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`
Type: string
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}
Description: 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.
Parameter Order: name
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.setIamPolicy
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$
Location: path
Description: 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.
Type: string
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.create
Parameter Order: parent
Description: 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).
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters
Parameters:
clusterId
Type: string
Description: 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)
Location: query
validateOnly
Location: query
Description: Optional. True if you want the request to be validated and not executed; false otherwise.
Type: boolean
requestId
Description: Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
Location: query
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Description: 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`
Path: v1/{+parent}/clusters
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:getIamPolicy
Parameters:
options.requestedPolicyVersion
Type: integer
Location: query
Format: int32
Description: 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).
resource
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$
Type: string
Location: path
Description: 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.
Required: Yes
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
HTTP Method: GET
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters:
resource
Type: string
Location: path
Required: Yes
Description: 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.
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.get
Path: v1/{+name}
HTTP Method: GET
Parameter Order: name
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$
Required: Yes
Location: path
Description: 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`
Description: Retrieves a `Cluster` resource by its resource name.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.patch
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}
HTTP Method: PATCH
Description: 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.
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Type: string
Format: google-fieldmask
Description: 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.
Location: query
name
Location: path
Description: Output only. 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`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$
validateOnly
Description: Optional. True if you want the request to be validated and not executed; false otherwise.
Type: boolean
Location: query
requestId
Location: query
Description: Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
▼ ▲ vmwareengine.projects.locations.privateClouds.getIamPolicy
HTTP Method: GET
Parameters:
resource
Description: 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.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Location: path
options.requestedPolicyVersion
Format: int32
Description: 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).
Location: query
Type: integer
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:getIamPolicy
▼ ▲ vmwareengine.projects.locations.privateClouds.setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Location: path
Type: string
Required: Yes
Description: 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.
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
▼ ▲ vmwareengine.projects.locations.privateClouds.undelete
Parameter Order: name
HTTP Method: POST
Description: Restores a private cloud that was previously scheduled for deletion by `DeletePrivateCloud`. A `PrivateCloud` resource scheduled for deletion has `PrivateCloud.state` set to `DELETED` and `PrivateCloud.expireTime` set to the time when deletion can no longer be reversed.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Description: 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`
Location: path
Type: string
Required: Yes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:undelete
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:undelete
▼ ▲ vmwareengine.projects.locations.privateClouds.resetNsxCredentials
Path: v1/{+privateCloud}:resetNsxCredentials
Parameters:
privateCloud
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Type: string
Description: 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`
Location: path
HTTP Method: POST
Description: Resets credentials of the NSX appliance.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:resetNsxCredentials
Parameter Order: privateCloud
▼ ▲ vmwareengine.projects.locations.privateClouds.testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters:
resource
Description: 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.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
HTTP Method: POST
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:testIamPermissions
▼ ▲ vmwareengine.projects.locations.privateClouds.resetVcenterCredentials
Parameters:
privateCloud
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Required: Yes
Description: 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`
Description: Resets credentials of the Vcenter appliance.
Parameter Order: privateCloud
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:resetVcenterCredentials
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+privateCloud}:resetVcenterCredentials
▼ ▲ vmwareengine.projects.locations.privateClouds.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}
Description: Retrieves a `PrivateCloud` resource by its resource name.
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Location: path
Required: Yes
Path: v1/{+name}
▼ ▲ vmwareengine.projects.locations.privateClouds.showNsxCredentials
Parameter Order: privateCloud
Description: Gets details of credentials for NSX appliance.
Parameters:
privateCloud
Required: Yes
Description: 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`
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Path: v1/{+privateCloud}:showNsxCredentials
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:showNsxCredentials
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ vmwareengine.projects.locations.privateClouds.list
Path: v1/{+parent}/privateClouds
HTTP Method: GET
Parameters:
orderBy
Type: string
Description: 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.
Location: query
filter
Description: 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") ```
Type: string
Location: query
pageToken
Description: 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.
Location: query
Type: string
parent
Required: Yes
Location: path
Type: string
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Type: integer
Description: 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.
Location: query
Format: int32
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds
Description: Lists `PrivateCloud` resources in a given project and location.
Parameter Order: parent
▼ ▲ vmwareengine.projects.locations.privateClouds.patch
Description: 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.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
updateMask
Location: query
Format: google-fieldmask
Description: 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.
Type: string
name
Location: path
Description: Output only. 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`
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
requestId
Type: string
Location: query
Description: Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}
Path: v1/{+name}
HTTP Method: PATCH
▼ ▲ vmwareengine.projects.locations.privateClouds.delete
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
Path: v1/{+name}
Parameter Order: name
Parameters:
force
Type: boolean
Description: 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.
Location: query
name
Description: 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`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Type: string
Required: Yes
requestId
Location: query
Type: string
Description: Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
delayHours
Format: int32
Description: 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`.
Location: query
Type: integer
▼ ▲ vmwareengine.projects.locations.privateClouds.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds
HTTP Method: POST
Description: Creates a new `PrivateCloud` resource in a given project and location. Private clouds of type `STANDARD` and `TIME_LIMITED` are zonal resources, `STRETCHED` private clouds are regional. Creating a private cloud also creates a [management cluster](https://cloud.google.com/vmware-engine/docs/concepts-vmware-components) for that private cloud.
Parameters:
privateCloudId
Location: query
Description: 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)
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Type: string
Description: 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`
validateOnly
Location: query
Type: boolean
Description: Optional. True if you want the request to be validated and not executed; false otherwise.
requestId
Location: query
Type: string
Description: Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Parameter Order: parent
Path: v1/{+parent}/privateClouds
▼ ▲ vmwareengine.projects.locations.privateClouds.showVcenterCredentials
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:showVcenterCredentials
Parameters:
privateCloud
Pattern: ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$
Type: string
Location: path
Required: Yes
Description: 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`
Path: v1/{+privateCloud}:showVcenterCredentials
Parameter Order: privateCloud
Description: Gets details of credentials for Vcenter appliance.
HTTP Method: GET
▼ ▲ vmwareengine.projects.locations.operations.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
Parameter Order: name
Parameters:
pageSize
Description: The standard list page size.
Location: query
Format: int32
Type: integer
filter
Location: query
Description: The standard list filter.
Type: string
pageToken
Location: query
Description: The standard list page token.
Type: string
name
Description: The name of the operation's parent resource.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
▼ ▲ vmwareengine.projects.locations.operations.delete
Description: 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`.
HTTP Method: DELETE
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be deleted.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Path: v1/{+name}
Parameter Order: name
▼ ▲ vmwareengine.projects.locations.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
HTTP Method: GET
Parameter Order: name
Description: 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.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters:
name
Description: The name of the operation resource.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
▼ ▲ vmwareengine.projects.locations.networkPolicies.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
name
Type: string
Location: path
Required: Yes
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/networkPolicies/[^/]+$
Description: Retrieves a `NetworkPolicy` resource by its resource name.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}
HTTP Method: GET
▼ ▲ vmwareengine.projects.locations.networkPolicies.create
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPolicies
Path: v1/{+parent}/networkPolicies
Parameters:
requestId
Location: query
Type: string
Description: 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).
parent
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: 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`
networkPolicyId
Description: 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)
Type: string
Location: query
Description: 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.
HTTP Method: POST
▼ ▲ vmwareengine.projects.locations.networkPolicies.patch
Parameters:
requestId
Description: 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).
Type: string
Location: query
updateMask
Type: string
Format: google-fieldmask
Location: query
Description: 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.
name
Required: Yes
Location: path
Type: string
Description: Output only. 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`
Pattern: ^projects/[^/]+/locations/[^/]+/networkPolicies/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}
Path: v1/{+name}
Description: 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.
HTTP Method: PATCH
Parameter Order: name
▼ ▲ vmwareengine.projects.locations.networkPolicies.list
Description: Lists `NetworkPolicy` resources in a specified project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPolicies
Parameters:
pageSize
Description: 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.
Location: query
Type: integer
Format: int32
pageToken
Type: string
Description: 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.
Location: query
orderBy
Description: 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.
Location: query
Type: string
filter
Description: 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") ```
Type: string
Location: query
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: 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`
Path: v1/{+parent}/networkPolicies
▼ ▲ vmwareengine.projects.locations.networkPolicies.delete
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
HTTP Method: DELETE
Description: Deletes a `NetworkPolicy` resource. A network policy cannot be deleted when `NetworkService.state` is set to `RECONCILING` for either its external IP or internet access service.
Parameters:
name
Required: Yes
Location: path
Description: 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`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/networkPolicies/[^/]+$
requestId
Location: query
Type: string
Description: 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).
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}
▼ ▲ vmwareengine.projects.locations.privateConnections.list
Parameters:
filter
Type: string
Location: query
Description: 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") ```
parent
Description: 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`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
pageToken
Description: 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.
Location: query
Type: string
pageSize
Format: int32
Location: query
Type: integer
Description: 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.
orderBy
Location: query
Description: 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.
Type: string
Description: Lists `PrivateConnection` resources in a given project and location.
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections
Path: v1/{+parent}/privateConnections
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ vmwareengine.projects.locations.privateConnections.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
HTTP Method: DELETE
Parameters:
requestId
Description: 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).
Location: query
Type: string
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Description: 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`
Description: 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.
Parameter Order: name
Path: v1/{+name}
▼ ▲ vmwareengine.projects.locations.privateConnections.patch
HTTP Method: PATCH
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
Parameter Order: name
Parameters:
updateMask
Location: query
Description: 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.
Type: string
Format: google-fieldmask
requestId
Type: string
Description: 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).
Location: query
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Description: 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`
Location: path
Required: Yes
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Modifies a `PrivateConnection` resource. Only `description` and `routing_mode` fields can be updated. Only fields specified in `updateMask` are applied.
▼ ▲ vmwareengine.projects.locations.privateConnections.get
HTTP Method: GET
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Description: 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`
Required: Yes
Type: string
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}
Description: Retrieves a `PrivateConnection` resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.
▼ ▲ vmwareengine.projects.locations.privateConnections.create
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: 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`
requestId
Description: 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).
Type: string
Location: query
privateConnectionId
Location: query
Type: string
Description: 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)
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Creates a new private connection that can be used for accessing private Clouds.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections
Path: v1/{+parent}/privateConnections
▼ ▲ vmwareengine.projects.locations.privateConnections.peeringRoutes.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/peeringRoutes
HTTP Method: GET
Parameter Order: parent
Parameters:
parent
Location: path
Required: Yes
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$
Type: string
pageToken
Type: string
Location: query
Description: 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.
pageSize
Type: integer
Description: 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.
Location: query
Format: int32
Path: v1/{+parent}/peeringRoutes
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists the private connection routes exchanged over a peering connection.
▼ ▲ vmwareengine.projects.locations.vmwareEngineNetworks.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: 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`
Location: path
pageSize
Description: 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.
Format: int32
Type: integer
Location: query
filter
Type: string
Location: query
Description: 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") ```
pageToken
Type: string
Location: query
Description: 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.
orderBy
Description: 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.
Type: string
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks
Description: Lists `VmwareEngineNetwork` resources in a given project and location.
HTTP Method: GET
Path: v1/{+parent}/vmwareEngineNetworks
▼ ▲ vmwareengine.projects.locations.vmwareEngineNetworks.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Modifies a VMware Engine network resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks/{vmwareEngineNetworksId}
HTTP Method: PATCH
Parameters:
updateMask
Location: query
Type: string
Description: 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`.
Format: google-fieldmask
requestId
Description: 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).
Location: query
Type: string
name
Description: Output only. 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`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareEngineNetworks/[^/]+$
Type: string
Path: v1/{+name}
▼ ▲ vmwareengine.projects.locations.vmwareEngineNetworks.create
Parameters:
requestId
Type: string
Description: 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).
Location: query
vmwareEngineNetworkId
Description: 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)
Type: string
Location: query
parent
Description: 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`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
HTTP Method: POST
Parameter Order: parent
Description: Creates a new VMware Engine network that can be used by a private cloud.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/vmwareEngineNetworks
▼ ▲ vmwareengine.projects.locations.vmwareEngineNetworks.get
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks/{vmwareEngineNetworksId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareEngineNetworks/[^/]+$
Description: 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`
Required: Yes
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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`).
HTTP Method: GET
Parameter Order: name
Path: v1/{+name}
▼ ▲ vmwareengine.projects.locations.vmwareEngineNetworks.delete
Parameters:
requestId
Location: query
Type: string
Description: 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).
etag
Location: query
Type: string
Description: 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.
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/vmwareEngineNetworks/[^/]+$
Description: 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`
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
Parameter Order: name
Path: v1/{+name}
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks/{vmwareEngineNetworksId}
▼ ▲ vmwareengine.projects.locations.nodeTypes.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single `NodeType`.
Parameter Order: name
HTTP Method: GET
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/nodeTypes/{nodeTypesId}
Parameters:
name
Type: string
Location: path
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/nodeTypes/[^/]+$
Required: Yes
▼ ▲ vmwareengine.projects.locations.nodeTypes.list
HTTP Method: GET
Description: Lists node types
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/nodeTypes
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/nodeTypes
Parameters:
pageToken
Type: string
Description: 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.
Location: query
filter
Description: 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") ```
Type: string
Location: query
pageSize
Description: 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.
Type: integer
Format: int32
Location: query
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: 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`
▼ ▲ vmwareengine.projects.locations.list
Path: v1/{+name}/locations
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations
Parameters:
pageSize
Description: The maximum number of results to return. If not set, the service selects a default.
Location: query
Type: integer
Format: int32
name
Description: The resource that owns the locations collection, if applicable.
Required: Yes
Pattern: ^projects/[^/]+$
Type: string
Location: path
pageToken
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type: string
Location: query
filter
Description: 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).
Type: string
Location: query
Description: Lists information about the supported locations for this service.
HTTP Method: GET
Parameter Order: name
▼ ▲ vmwareengine.projects.locations.get
HTTP Method: GET
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: Resource name for the location.
Path: v1/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
Description: Gets information about a location.