package google.cloud.vmwareengine.v1
Get desktop application:
View/edit binary Protocol Buffers messages
VMwareEngine manages VMware's private clusters in the Cloud.
Lists `PrivateCloud` resources in a given project and location.
message
vmwareengine.proto:1021Request message for [VmwareEngine.ListPrivateClouds][google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateClouds]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:1085Response message for [VmwareEngine.ListPrivateClouds][google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateClouds]
repeated private_clouds = 1
A list of private clouds.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
rpc GetPrivateCloud (, )
vmwareengine.proto:58Retrieves a `PrivateCloud` resource by its resource name.
message
vmwareengine.proto:1100Request message for [VmwareEngine.GetPrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.GetPrivateCloud]
string name = 1
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`
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.
message
vmwareengine.proto:1116Request message for [VmwareEngine.CreatePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.CreatePrivateCloud]
string parent = 1
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`
string private_cloud_id = 2
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)
optional private_cloud = 3
Required. The initial description of the new private cloud.
string request_id = 4
Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
bool validate_only = 5
Optional. True if you want the request to be validated and not executed; false otherwise.
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.
message
vmwareengine.proto:1156Request message for [VmwareEngine.UpdatePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.UpdatePrivateCloud]
optional private_cloud = 1
Required. Private cloud description.
optional update_mask = 2
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.
string request_id = 3
Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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.
message
vmwareengine.proto:1175Request message for [VmwareEngine.DeletePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.DeletePrivateCloud]
string name = 1
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`
string request_id = 2
Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
bool force = 3
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.
optional int32 delay_hours = 4
Optional. Time delay of the deletion specified in hours. The default value is `3`. Specifying a non-zero value for this field changes the value of `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned deletion time. Deletion can be cancelled before `expire_time` elapses using [VmwareEngine.UndeletePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud]. Specifying a value of `0` for this field instead begins the deletion process and ceases billing immediately. During the final deletion process, the value of `PrivateCloud.state` becomes `PURGING`.
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.
message
vmwareengine.proto:1212Request message for [VmwareEngine.UndeletePrivateCloud][google.cloud.vmwareengine.v1.VmwareEngine.UndeletePrivateCloud]
string name = 1
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`
string request_id = 2
Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
rpc ListClusters (, )
vmwareengine.proto:152Lists `Cluster` resources in a given private cloud.
message
vmwareengine.proto:1232Request message for [VmwareEngine.ListClusters][google.cloud.vmwareengine.v1.VmwareEngine.ListClusters]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:1284Response message for [VmwareEngine.ListClusters][google.cloud.vmwareengine.v1.VmwareEngine.ListClusters]
repeated clusters = 1
A list of private cloud clusters.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
rpc GetCluster (, )
vmwareengine.proto:160Retrieves a `Cluster` resource by its resource name.
message
vmwareengine.proto:1299Request message for [VmwareEngine.GetCluster][google.cloud.vmwareengine.v1.VmwareEngine.GetCluster]
string name = 1
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`
rpc CreateCluster (, )
vmwareengine.proto:171Creates 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).
message
vmwareengine.proto:1315Request message for [VmwareEngine.CreateCluster][google.cloud.vmwareengine.v1.VmwareEngine.CreateCluster]
string parent = 1
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`
string cluster_id = 2
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)
optional cluster = 3
Required. The initial description of the new cluster.
string request_id = 4
Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
bool validate_only = 5
Optional. True if you want the request to be validated and not executed; false otherwise.
rpc UpdateCluster (, )
vmwareengine.proto:191Modifies 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.
message
vmwareengine.proto:1355Request message for [VmwareEngine.UpdateCluster][google.cloud.vmwareengine.v1.VmwareEngine.UpdateCluster]
optional update_mask = 1
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.
optional cluster = 2
Required. The description of the cluster.
string request_id = 3
Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
bool validate_only = 4
Optional. True if you want the request to be validated and not executed; false otherwise.
rpc DeleteCluster (, )
vmwareengine.proto:208Deletes 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.
message
vmwareengine.proto:1378Request message for [VmwareEngine.DeleteCluster][google.cloud.vmwareengine.v1.VmwareEngine.DeleteCluster]
string name = 1
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`
string request_id = 2
Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
rpc ListNodes (, )
vmwareengine.proto:221Lists nodes in a given cluster.
message
vmwareengine.proto:1398Request message for [VmwareEngine.ListNodes][google.cloud.vmwareengine.v1.VmwareEngine.ListNodes]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
message
vmwareengine.proto:1428Response message for [VmwareEngine.ListNodes][google.cloud.vmwareengine.v1.VmwareEngine.ListNodes]
repeated nodes = 1
The nodes.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
rpc GetNode (, )
vmwareengine.proto:229Gets details of a single node.
message
vmwareengine.proto:1439Request message for [VmwareEngine.GetNode][google.cloud.vmwareengine.v1.VmwareEngine.GetNode]
string name = 1
Required. The resource name of the node to retrieve. For example: `projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}`
Lists external IP addresses assigned to VMware workload VMs in a given private cloud.
message
vmwareengine.proto:1453Request message for [VmwareEngine.ListExternalAddresses][google.cloud.vmwareengine.v1.VmwareEngine.ListExternalAddresses]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:1517Response message for [VmwareEngine.ListExternalAddresses][google.cloud.vmwareengine.v1.VmwareEngine.ListExternalAddresses]
repeated external_addresses = 1
A list of external IP addresses.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
Lists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.
message
vmwareengine.proto:1532Request message for [VmwareEngine.FetchNetworkPolicyExternalAddresses][google.cloud.vmwareengine.v1.VmwareEngine.FetchNetworkPolicyExternalAddresses]
string network_policy = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
message
vmwareengine.proto:1563Response message for [VmwareEngine.FetchNetworkPolicyExternalAddresses][google.cloud.vmwareengine.v1.VmwareEngine.FetchNetworkPolicyExternalAddresses]
repeated external_addresses = 1
A list of external IP addresses assigned to VMware workload VMs within the scope of the given network policy.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Gets details of a single external IP address.
message
vmwareengine.proto:1575Request message for [VmwareEngine.GetExternalAddress][google.cloud.vmwareengine.v1.VmwareEngine.GetExternalAddress]
string name = 1
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`
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`).
message
vmwareengine.proto:1591Request message for [VmwareEngine.CreateExternalAddress][google.cloud.vmwareengine.v1.VmwareEngine.CreateExternalAddress]
string parent = 1
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`
optional external_address = 2
Required. The initial description of a new external IP address.
string external_address_id = 3
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)
string request_id = 4
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).
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.
message
vmwareengine.proto:1640Request message for [VmwareEngine.UpdateExternalAddress][google.cloud.vmwareengine.v1.VmwareEngine.UpdateExternalAddress]
optional update_mask = 1
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.
optional external_address = 2
Required. External IP address description.
string request_id = 3
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).
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.
message
vmwareengine.proto:1671Request message for [VmwareEngine.DeleteExternalAddress][google.cloud.vmwareengine.v1.VmwareEngine.DeleteExternalAddress]
string name = 1
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`
string request_id = 2
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).
rpc ListSubnets (, )
vmwareengine.proto:318Lists subnets in a given private cloud.
message
vmwareengine.proto:1703Request message for [VmwareEngine.ListSubnets][google.cloud.vmwareengine.v1.VmwareEngine.ListSubnets]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
message
vmwareengine.proto:1733Response message for [VmwareEngine.ListSubnets][google.cloud.vmwareengine.v1.VmwareEngine.ListSubnets]
repeated subnets = 1
A list of subnets.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
rpc GetSubnet (, )
vmwareengine.proto:326Gets details of a single subnet.
message
vmwareengine.proto:1748Request message for [VmwareEngine.GetSubnet][google.cloud.vmwareengine.v1.VmwareEngine.GetSubnet]
string name = 1
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`
rpc UpdateSubnet (, )
vmwareengine.proto:339Updates 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.
message
vmwareengine.proto:1764Request message for [VmwareEngine.UpdateSubnet][google.cloud.vmwareengine.v1.VmwareEngine.UpdateSubnet]
optional update_mask = 1
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.
optional subnet = 2
Required. Subnet description.
Lists `ExternalAccessRule` resources in the specified network policy.
message
vmwareengine.proto:1779Request message for [VmwareEngine.ListExternalAccessRules][google.cloud.vmwareengine.v1.VmwareEngine.ListExternalAccessRules]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:1843Response message for [VmwareEngine.ListExternalAccessRules][google.cloud.vmwareengine.v1.VmwareEngine.ListExternalAccessRules]
repeated external_access_rules = 1
A list of external access firewall rules.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
Gets details of a single external access rule.
message
vmwareengine.proto:1858Request message for [VmwareEngine.GetExternalAccessRule][google.cloud.vmwareengine.v1.VmwareEngine.GetExternalAccessRule]
string name = 1
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`
Creates a new external access rule in a given network policy.
message
vmwareengine.proto:1874Request message for [VmwareEngine.CreateExternalAccessRule][google.cloud.vmwareengine.v1.VmwareEngine.CreateExternalAccessRule]
string parent = 1
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`
optional external_access_rule = 2
Required. The initial description of a new external access rule.
string external_access_rule_id = 3
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)
string request_id = 4
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).
Updates the parameters of a single external access rule. Only fields specified in `update_mask` are applied.
message
vmwareengine.proto:1924Request message for [VmwareEngine.UpdateExternalAccessRule][google.cloud.vmwareengine.v1.VmwareEngine.UpdateExternalAccessRule]
optional update_mask = 1
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.
optional external_access_rule = 2
Required. Description of the external access rule.
string request_id = 3
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).
Deletes a single external access rule.
message
vmwareengine.proto:1956Request message for [VmwareEngine.DeleteExternalAccessRule][google.cloud.vmwareengine.v1.VmwareEngine.DeleteExternalAccessRule]
string name = 1
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`
string request_id = 2
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).
Lists logging servers configured for a given private cloud.
message
vmwareengine.proto:1988Request message for [VmwareEngine.ListLoggingServers][google.cloud.vmwareengine.v1.VmwareEngine.ListLoggingServers]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:2053Response message for [VmwareEngine.ListLoggingServers][google.cloud.vmwareengine.v1.VmwareEngine.ListLoggingServers]
repeated logging_servers = 1
A list of Logging Servers.
string next_page_token = 2
A token, which can be send as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
Gets details of a logging server.
message
vmwareengine.proto:2068Request message for [VmwareEngine.GetLoggingServer][google.cloud.vmwareengine.v1.VmwareEngine.GetLoggingServer]
string name = 1
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`
Create a new logging server for a given private cloud.
message
vmwareengine.proto:2084Request message for [VmwareEngine.CreateLoggingServer][google.cloud.vmwareengine.v1.VmwareEngine.CreateLoggingServer]
string parent = 1
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`
optional logging_server = 2
Required. The initial description of a new logging server.
string logging_server_id = 3
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)
string request_id = 4
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).
Updates the parameters of a single logging server. Only fields specified in `update_mask` are applied.
message
vmwareengine.proto:2133Request message for [VmwareEngine.UpdateLoggingServer][google.cloud.vmwareengine.v1.VmwareEngine.UpdateLoggingServer]
optional update_mask = 1
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.
optional logging_server = 2
Required. Logging server description.
string request_id = 3
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).
Deletes a single logging server.
message
vmwareengine.proto:2164Request message for [VmwareEngine.DeleteLoggingServer][google.cloud.vmwareengine.v1.VmwareEngine.DeleteLoggingServer]
string name = 1
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`
string request_id = 2
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).
rpc ListNodeTypes (, )
vmwareengine.proto:474Lists node types
message
vmwareengine.proto:2227Request message for [VmwareEngine.ListNodeTypes][google.cloud.vmwareengine.v1.VmwareEngine.ListNodeTypes]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
message
vmwareengine.proto:2283Response message for [VmwareEngine.ListNodeTypes][google.cloud.vmwareengine.v1.VmwareEngine.ListNodeTypes]
repeated node_types = 1
A list of Node Types.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
rpc GetNodeType (, )
vmwareengine.proto:482Gets details of a single `NodeType`.
message
vmwareengine.proto:2298Request message for [VmwareEngine.GetNodeType][google.cloud.vmwareengine.v1.VmwareEngine.GetNodeType]
string name = 1
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`
Gets details of credentials for NSX appliance.
message
vmwareengine.proto:2314Request message for [VmwareEngine.ShowNsxCredentials][google.cloud.vmwareengine.v1.VmwareEngine.ShowNsxCredentials]
string private_cloud = 1
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`
Gets details of credentials for Vcenter appliance.
message
vmwareengine.proto:2331Request message for [VmwareEngine.ShowVcenterCredentials][google.cloud.vmwareengine.v1.VmwareEngine.ShowVcenterCredentials]
string private_cloud = 1
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`
string username = 2
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.
Resets credentials of the NSX appliance.
message
vmwareengine.proto:2360Request message for [VmwareEngine.ResetNsxCredentials][google.cloud.vmwareengine.v1.VmwareEngine.ResetNsxCredentials]
string private_cloud = 1
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`
string request_id = 2
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).
Resets credentials of the Vcenter appliance.
message
vmwareengine.proto:2393Request message for [VmwareEngine.ResetVcenterCredentials][google.cloud.vmwareengine.v1.VmwareEngine.ResetVcenterCredentials]
string private_cloud = 1
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`
string request_id = 2
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).
string username = 3
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.
Gets details of the `DnsForwarding` config.
message
vmwareengine.proto:2548Request message for [VmwareEngine.GetDnsForwarding][google.cloud.vmwareengine.v1.VmwareEngine.GetDnsForwarding]
string name = 1
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`
Updates the parameters of the `DnsForwarding` config, like associated domains. Only fields specified in `update_mask` are applied.
message
vmwareengine.proto:2564Request message for [VmwareEngine.UpdateDnsForwarding][google.cloud.vmwareengine.v1.VmwareEngine.UpdateDnsForwarding]
optional dns_forwarding = 1
Required. DnsForwarding config details.
optional update_mask = 2
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.
string request_id = 3
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).
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.
message
vmwareengine.proto:2675Request message for [VmwareEngine.GetNetworkPeering][google.cloud.vmwareengine.v1.VmwareEngine.GetNetworkPeering]
string name = 1
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`
Lists `NetworkPeering` resources in a given project. NetworkPeering is a global resource and location can only be global.
message
vmwareengine.proto:2691Request message for [VmwareEngine.ListNetworkPeerings][google.cloud.vmwareengine.v1.VmwareEngine.ListNetworkPeerings]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:2784Response message for [VmwareEngine.ListNetworkPeerings][google.cloud.vmwareengine.v1.VmwareEngine.ListNetworkPeerings]
repeated network_peerings = 1
A list of network peerings.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Unreachable resources.
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.
message
vmwareengine.proto:2595Request message for [VmwareEngine.CreateNetworkPeering][google.cloud.vmwareengine.v1.VmwareEngine.CreateNetworkPeering]
string parent = 1
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`
string network_peering_id = 2
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)
optional network_peering = 3
Required. The initial description of the new network peering.
string request_id = 4
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).
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.
message
vmwareengine.proto:2643Request message for [VmwareEngine.DeleteNetworkPeering][google.cloud.vmwareengine.v1.VmwareEngine.DeleteNetworkPeering]
string name = 1
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`
string request_id = 2
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).
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.
message
vmwareengine.proto:2753Request message for [VmwareEngine.UpdateNetworkPeering][google.cloud.vmwareengine.v1.VmwareEngine.UpdateNetworkPeering]
optional network_peering = 1
Required. Network peering description.
optional update_mask = 2
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.
string request_id = 3
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).
Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.
message
vmwareengine.proto:2798Request message for [VmwareEngine.ListPeeringRoutes][google.cloud.vmwareengine.v1.VmwareEngine.ListPeeringRoutes]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 6
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.
message
vmwareengine.proto:2832Response message for [VmwareEngine.ListPeeringRoutes][google.cloud.vmwareengine.v1.VmwareEngine.ListPeeringRoutes]
repeated peering_routes = 1
A list of peering routes.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Creates a new HCX activation key in a given private cloud.
message
vmwareengine.proto:2498Request message for [VmwareEngine.CreateHcxActivationKey][google.cloud.vmwareengine.v1.VmwareEngine.CreateHcxActivationKey]
string parent = 1
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`
optional hcx_activation_key = 2
Required. The initial description of a new HCX activation key. When creating a new key, this field must be an empty object.
string hcx_activation_key_id = 3
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)
string request_id = 4
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).
Lists `HcxActivationKey` resources in a given private cloud.
message
vmwareengine.proto:2452Request message for [VmwareEngine.ListHcxActivationKeys][google.cloud.vmwareengine.v1.VmwareEngine.ListHcxActivationKeys]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
message
vmwareengine.proto:2437Response message for [VmwareEngine.ListHcxActivationKeys][google.cloud.vmwareengine.v1.VmwareEngine.ListHcxActivationKeys]
repeated hcx_activation_keys = 1
List of HCX activation keys.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
Retrieves a `HcxActivationKey` resource by its resource name.
message
vmwareengine.proto:2482Request message for [VmwareEngine.GetHcxActivationKeys][]
string name = 1
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`
Retrieves a `NetworkPolicy` resource by its resource name.
message
vmwareengine.proto:2921Request message for [VmwareEngine.GetNetworkPolicy][google.cloud.vmwareengine.v1.VmwareEngine.GetNetworkPolicy]
string name = 1
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`
Lists `NetworkPolicy` resources in a specified project and location.
message
vmwareengine.proto:2843Request message for [VmwareEngine.ListNetworkPolicies][google.cloud.vmwareengine.v1.VmwareEngine.ListNetworkPolicies]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:2906Response message for [VmwareEngine.ListNetworkPolicies][google.cloud.vmwareengine.v1.VmwareEngine.ListNetworkPolicies]
repeated network_policies = 1
A list of network policies.
string next_page_token = 2
A token, which can be send as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
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.
message
vmwareengine.proto:2968Request message for [VmwareEngine.CreateNetworkPolicy][google.cloud.vmwareengine.v1.VmwareEngine.CreateNetworkPolicy]
string parent = 1
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`
string network_policy_id = 2
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)
optional network_policy = 3
Required. The network policy configuration to use in the request.
string request_id = 4
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).
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.
message
vmwareengine.proto:2937Request message for [VmwareEngine.UpdateNetworkPolicy][google.cloud.vmwareengine.v1.VmwareEngine.UpdateNetworkPolicy]
optional network_policy = 1
Required. Network policy description.
optional update_mask = 2
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.
string request_id = 3
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).
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.
message
vmwareengine.proto:3018Request message for [VmwareEngine.DeleteNetworkPolicy][google.cloud.vmwareengine.v1.VmwareEngine.DeleteNetworkPolicy]
string name = 1
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`
string request_id = 2
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).
Lists Consumer VPCs bound to Management DNS Zone of a given private cloud.
message
vmwareengine.proto:3050Request message for [VmwareEngine.ListManagementDnsZoneBindings][google.cloud.vmwareengine.v1.VmwareEngine.ListManagementDnsZoneBindings]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:3115Response message for [VmwareEngine.ListManagementDnsZoneBindings][google.cloud.vmwareengine.v1.VmwareEngine.ListManagementDnsZoneBindings]
repeated management_dns_zone_bindings = 1
A list of management DNS zone bindings.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached when making an aggregated query using wildcards.
Retrieves a 'ManagementDnsZoneBinding' resource by its resource name.
message
vmwareengine.proto:3130Request message for [VmwareEngine.GetManagementDnsZoneBinding][google.cloud.vmwareengine.v1.VmwareEngine.GetManagementDnsZoneBinding]
string name = 1
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`
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.
message
vmwareengine.proto:3145Request message for [VmwareEngine.CreateManagementDnsZoneBindings][]
string parent = 1
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`
optional management_dns_zone_binding = 2
Required. The initial values for a new management DNS zone binding.
string management_dns_zone_binding_id = 3
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)
string request_id = 4
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).
Updates a `ManagementDnsZoneBinding` resource. Only fields specified in `update_mask` are applied.
message
vmwareengine.proto:3197Request message for [VmwareEngine.UpdateManagementDnsZoneBinding][google.cloud.vmwareengine.v1.VmwareEngine.UpdateManagementDnsZoneBinding]
optional update_mask = 1
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.
optional management_dns_zone_binding = 2
Required. New values to update the management DNS zone binding with.
string request_id = 3
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).
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.
message
vmwareengine.proto:3229Request message for [VmwareEngine.DeleteManagementDnsZoneBinding][google.cloud.vmwareengine.v1.VmwareEngine.DeleteManagementDnsZoneBinding]
string name = 1
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`
string request_id = 2
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).
Retries to create a `ManagementDnsZoneBinding` resource that is in failed state.
message
vmwareengine.proto:3260Request message for [VmwareEngine.RepairManagementDnsZoneBindings][]
string name = 1
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`
string request_id = 2
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).
Creates a new VMware Engine network that can be used by a private cloud.
message
vmwareengine.proto:3292Request message for [VmwareEngine.CreateVmwareEngineNetwork][google.cloud.vmwareengine.v1.VmwareEngine.CreateVmwareEngineNetwork]
string parent = 1
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`
string vmware_engine_network_id = 2
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)
optional vmware_engine_network = 3
Required. The initial description of the new VMware Engine network.
string request_id = 4
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).
Modifies a VMware Engine network resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied.
message
vmwareengine.proto:3346Request message for [VmwareEngine.UpdateVmwareEngineNetwork][google.cloud.vmwareengine.v1.VmwareEngine.UpdateVmwareEngineNetwork]
optional vmware_engine_network = 1
Required. VMware Engine network description.
optional update_mask = 2
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`.
string request_id = 3
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).
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.
message
vmwareengine.proto:3379Request message for [VmwareEngine.DeleteVmwareEngineNetwork][google.cloud.vmwareengine.v1.VmwareEngine.DeleteVmwareEngineNetwork]
string name = 1
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`
string request_id = 2
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).
string etag = 3
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.
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`).
message
vmwareengine.proto:3417Request message for [VmwareEngine.GetVmwareEngineNetwork][google.cloud.vmwareengine.v1.VmwareEngine.GetVmwareEngineNetwork]
string name = 1
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`
Lists `VmwareEngineNetwork` resources in a given project and location.
message
vmwareengine.proto:3433Request message for [VmwareEngine.ListVmwareEngineNetworks][google.cloud.vmwareengine.v1.VmwareEngine.ListVmwareEngineNetworks]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:3495Response message for [VmwareEngine.ListVmwareEngineNetworks][google.cloud.vmwareengine.v1.VmwareEngine.ListVmwareEngineNetworks]
repeated vmware_engine_networks = 1
A list of VMware Engine networks.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Unreachable resources.
Creates a new private connection that can be used for accessing private Clouds.
message
vmwareengine.proto:3509Request message for [VmwareEngine.CreatePrivateConnection][google.cloud.vmwareengine.v1.VmwareEngine.CreatePrivateConnection]
string parent = 1
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`
string private_connection_id = 2
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)
optional private_connection = 3
Required. The initial description of the new private connection.
string request_id = 4
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).
Retrieves a `PrivateConnection` resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.
message
vmwareengine.proto:3558Request message for [VmwareEngine.GetPrivateConnection][google.cloud.vmwareengine.v1.VmwareEngine.GetPrivateConnection]
string name = 1
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`
Lists `PrivateConnection` resources in a given project and location.
message
vmwareengine.proto:3574Request message for [VmwareEngine.ListPrivateConnections][google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateConnections]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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") ```
string order_by = 5
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.
message
vmwareengine.proto:3636Response message for [VmwareEngine.ListPrivateConnections][google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateConnections]
repeated private_connections = 1
A list of private connections.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Unreachable resources.
Modifies a `PrivateConnection` resource. Only `description` and `routing_mode` fields can be updated. Only fields specified in `updateMask` are applied.
message
vmwareengine.proto:3650Request message for [VmwareEngine.UpdatePrivateConnection][google.cloud.vmwareengine.v1.VmwareEngine.UpdatePrivateConnection]
optional private_connection = 1
Required. Private connection description.
optional update_mask = 2
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.
string request_id = 3
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).
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.
message
vmwareengine.proto:3682Request message for [VmwareEngine.DeletePrivateConnection][google.cloud.vmwareengine.v1.VmwareEngine.DeletePrivateConnection]
string name = 1
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`
string request_id = 2
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).
Lists the private connection routes exchanged over a peering connection.
message
vmwareengine.proto:3714Request message for [VmwareEngine.ListPrivateConnectionPeeringRoutes][google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateConnectionPeeringRoutes]
string parent = 1
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`
int32 page_size = 2
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.
string page_token = 3
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.
message
vmwareengine.proto:3741Response message for [VmwareEngine.ListPrivateConnectionPeeringRoutes][google.cloud.vmwareengine.v1.VmwareEngine.ListPrivateConnectionPeeringRoutes]
repeated peering_routes = 1
A list of peering routes.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
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.
message
vmwareengine.proto:3752Request message for [VmwareEngine.GrantDnsBindPermission][google.cloud.vmwareengine.v1.VmwareEngine.GrantDnsBindPermission]
string name = 1
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`
optional principal = 2
Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project.
string request_id = 3
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).
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.
message
vmwareengine.proto:3828Request message for [VmwareEngine.GetDnsBindPermission][google.cloud.vmwareengine.v1.VmwareEngine.GetDnsBindPermission]
string name = 1
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`
DnsBindPermission resource that contains the accounts having the consumer DNS bind permission on the corresponding intranet VPC of the consumer project.
string name = 1
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`
repeated principals = 2
Output only. Users/Service accounts which have access for binding on the intranet VPC project corresponding to the consumer project.
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.
message
vmwareengine.proto:3790Request message for [VmwareEngine.RevokeDnsBindPermission][google.cloud.vmwareengine.v1.VmwareEngine.RevokeDnsBindPermission]
string name = 1
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`
optional principal = 2
Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project.
string request_id = 3
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).
message
vmwareengine_resources.proto:916Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud.
Used in:
map<string, > autoscaling_policies = 1
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.
int32 min_cluster_node_count = 2
Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply.
int32 max_cluster_node_count = 3
Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply.
optional cool_down_period = 4
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).
message
vmwareengine_resources.proto:933Autoscaling 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.
Used in:
string node_type_id = 1
Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`.
int32 scale_out_size = 2
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.
optional cpu_thresholds = 11
Optional. Utilization thresholds pertaining to CPU utilization.
optional granted_memory_thresholds = 12
Optional. Utilization thresholds pertaining to amount of granted memory.
optional consumed_memory_thresholds = 13
Optional. Utilization thresholds pertaining to amount of consumed memory.
optional storage_thresholds = 14
Optional. Utilization thresholds pertaining to amount of consumed storage.
message
vmwareengine_resources.proto:919Thresholds define the utilization of resources triggering scale-out and scale-in operations.
Used in:
int32 scale_out = 1
Required. The utilization triggering the scale-out operation in percent.
int32 scale_in = 2
Required. The utilization triggering the scale-in operation in percent.
message
vmwareengine_resources.proto:252A cluster in a private cloud.
Used as response type in: VmwareEngine.GetCluster
Used as field type in: , ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
Cluster.State state = 6
Output only. State of the resource.
bool management = 7
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.
optional autoscaling_settings = 18
Optional. Configuration of the autoscaling applied to this cluster.
string uid = 14
Output only. System-generated unique identifier for the resource.
map<string, > node_type_configs = 16
Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`).
optional stretched_cluster_config = 17
Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud.
Enum State defines possible states of private cloud clusters.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value should never be used.
ACTIVE = 1
The Cluster is operational and can be used by the user.
CREATING = 2
The Cluster is being deployed.
UPDATING = 3
Adding or removing of a node to the cluster, any other cluster specific updates.
DELETING = 4
The Cluster is being deleted.
REPAIRING = 5
The Cluster is undergoing maintenance, for example: a failed node is getting replaced.
message
vmwareengine_resources.proto:772Credentials for a private cloud.
Used as response type in: VmwareEngine.ShowNsxCredentials, VmwareEngine.ShowVcenterCredentials
string username = 1
Initial username.
string password = 2
Initial password.
message
vmwareengine_resources.proto:995DNS forwarding config. This config defines a list of domain to name server mappings, and is attached to the private cloud for custom domain resolution.
Used as response type in: VmwareEngine.GetDnsForwarding
Used as field type in:
string name = 1
Output only. 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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
repeated forwarding_rules = 4
Required. List of domain mappings to configure
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.
Used in:
string domain = 1
Required. Domain used to resolve a `name_servers` list.
repeated string name_servers = 2
Required. List of DNS servers to use for domain resolution
message
vmwareengine_resources.proto:493External access firewall rules for filtering incoming traffic destined to `ExternalAddress` resources.
Used as response type in: VmwareEngine.GetExternalAccessRule
Used as field type in: , ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
string description = 5
User-provided description for this external access rule.
int32 priority = 6
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`.
ExternalAccessRule.Action action = 7
The action that the external access rule performs.
string ip_protocol = 8
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`.
repeated source_ip_ranges = 9
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`.
repeated string source_ports = 10
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"]`.
repeated destination_ip_ranges = 11
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.
repeated string destination_ports = 12
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"]`.
ExternalAccessRule.State state = 13
Output only. The state of the resource.
string uid = 14
Output only. System-generated unique identifier for the resource.
Action determines whether the external access rule permits or blocks traffic, subject to the other components of the rule matching the traffic.
Used in:
ACTION_UNSPECIFIED = 0
Defaults to allow.
ALLOW = 1
Allows connections that match the other specified components.
DENY = 2
Blocks connections that match the other specified components.
message
vmwareengine_resources.proto:513An IP range provided in any one of the supported formats.
Used in:
oneof ip_range
string ip_address = 1
A single IP address. For example: `10.0.0.5`.
string ip_address_range = 2
An IP address range in the CIDR format. For example: `10.0.0.0/24`.
string external_address = 3
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`.
Defines possible states of external access firewall rules.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value is used if the state is omitted.
ACTIVE = 1
The rule is ready.
CREATING = 2
The rule is being created.
UPDATING = 3
The rule is being updated.
DELETING = 4
The rule is being deleted.
message
vmwareengine_resources.proto:378Represents an allocated external IP address and its corresponding internal IP address in a private cloud.
Used as response type in: VmwareEngine.GetExternalAddress
Used as field type in: , , ,
string name = 1
Output only. 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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
string internal_ip = 6
The internal IP address of a workload VM.
string external_ip = 7
Output only. The external IP address of a workload VM.
ExternalAddress.State state = 8
Output only. The state of the resource.
string uid = 9
Output only. System-generated unique identifier for the resource.
string description = 11
User-provided description for this resource.
Enum State defines possible states of external addresses.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value should never be used.
ACTIVE = 1
The address is ready.
CREATING = 2
The address is being created.
UPDATING = 3
The address is being updated.
DELETING = 4
The address is being deleted.
message
vmwareengine_resources.proto:831Details about a HCX Cloud Manager appliance.
Used in:
string internal_ip = 2
Internal IP address of the appliance.
string version = 4
Version of the appliance.
Hcx.State state = 5
Output only. The state of the appliance.
string fqdn = 6
Fully qualified domain name of the appliance.
State of the appliance
Used in:
STATE_UNSPECIFIED = 0
Unspecified appliance state. This is the default value.
ACTIVE = 1
The appliance is operational and can be used.
CREATING = 2
The appliance is being deployed.
ACTIVATING = 3
The appliance is being activated.
message
vmwareengine_resources.proto:788HCX 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][google.cloud.vmwareengine.v1.VmwareEngine.ListHcxActivationKeys] to retrieve existing keys and [VmwareEngine.CreateHcxActivationKey][google.cloud.vmwareengine.v1.VmwareEngine.CreateHcxActivationKey] to create new ones.
Used as response type in: VmwareEngine.GetHcxActivationKey
Used as field type in: ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of HCX activation key.
HcxActivationKey.State state = 3
Output only. State of HCX activation key.
string activation_key = 4
Output only. HCX activation key.
string uid = 5
Output only. System-generated unique identifier for the resource.
State of HCX activation key
Used in:
STATE_UNSPECIFIED = 0
Unspecified state.
AVAILABLE = 1
State of a newly generated activation key.
CONSUMED = 2
State of key when it has been used to activate HCX appliance.
CREATING = 3
State of key when it is being created.
VmwareEngine specific metadata for the given [google.cloud.location.Location][google.cloud.location.Location]. It is returned as a content of the `google.cloud.location.Location.metadata` field.
repeated LocationMetadata.Capability capabilities = 1
Output only. Capabilities of this location.
Capability of a location.
Used in:
CAPABILITY_UNSPECIFIED = 0
The default value. This value is used if the capability is omitted or unknown.
STRETCHED_CLUSTERS = 1
Stretch clusters are supported in this location.
message
vmwareengine_resources.proto:625Logging server to receive vCenter or ESXi logs.
Used as response type in: VmwareEngine.GetLoggingServer
Used as field type in: , ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
string hostname = 5
Required. Fully-qualified domain name (FQDN) or IP Address of the logging server.
int32 port = 7
Required. Port number at which the logging server receives logs.
LoggingServer.Protocol protocol = 6
Required. Protocol used by vCenter to send logs to a logging server.
LoggingServer.SourceType source_type = 10
Required. The type of component that produces logs that will be forwarded to this logging server.
string uid = 8
Output only. System-generated unique identifier for the resource.
Defines possible protocols used to send logs to a logging server.
Used in:
PROTOCOL_UNSPECIFIED = 0
Unspecified communications protocol. This is the default value.
UDP = 1
UDP
TCP = 2
TCP
TLS = 3
TLS
SSL = 4
SSL
RELP = 5
RELP
Defines possible types of component that produces logs.
Used in:
SOURCE_TYPE_UNSPECIFIED = 0
The default value. This value should never be used.
ESXI = 1
Logs produced by ESXI hosts
VCSA = 2
Logs produced by vCenter server
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.
Used as response type in: VmwareEngine.GetManagementDnsZoneBinding
Used as field type in: , ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
ManagementDnsZoneBinding.State state = 8
Output only. The state of the resource.
string description = 13
User-provided description for this resource.
oneof bind_network
Required. The relative resource name of the network to bind to the management DNS zone. This network can be a consumer VPC network or a VMware engine network.
string vpc_network = 14
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.
string vmware_engine_network = 15
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.
string uid = 9
Output only. System-generated unique identifier for the resource.
Enum State defines possible states of binding between the consumer VPC network and the management DNS zone.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value should never be used.
ACTIVE = 1
The binding is ready.
CREATING = 2
The binding is being created.
UPDATING = 3
The binding is being updated.
DELETING = 4
The binding is being deleted.
FAILED = 5
The binding has failed.
message
vmwareengine_resources.proto:35Network configuration in the consumer project with which the peering has to be done.
Used in:
string management_cidr = 4
Required. Management CIDR used by VMware management appliances.
string vmware_engine_network = 5
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.
string vmware_engine_network_canonical = 6
Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}`
int32 management_ip_address_layout_version = 8
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.
string dns_server_ip = 9
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.
Details of a network peering.
Used as response type in: VmwareEngine.GetNetworkPeering
Used as field type in: , ,
string name = 1
Output only. 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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
string peer_network = 5
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.
optional bool export_custom_routes = 8
Optional. True if custom routes are exported to the peered network; false otherwise. The default value is true.
optional bool import_custom_routes = 9
Optional. True if custom routes are imported from the peered network; false otherwise. The default value is true.
optional bool exchange_subnet_routes = 10
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'.
optional bool export_custom_routes_with_public_ip = 11
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.
optional bool import_custom_routes_with_public_ip = 12
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.
NetworkPeering.State state = 13
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.
string state_details = 7
Output only. Output Only. Details about the current state of the network peering.
int32 peer_mtu = 14
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.
NetworkPeering.PeerNetworkType peer_network_type = 16
Required. The type of the network to peer with the VMware Engine network.
string uid = 17
Output only. System-generated unique identifier for the resource.
string vmware_engine_network = 20
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.
string description = 21
Optional. User-provided description for this network peering.
Type or purpose of the network peering connection.
Used in:
PEER_NETWORK_TYPE_UNSPECIFIED = 0
Unspecified
STANDARD = 1
Peering connection used for connecting to another VPC network established by the same user. For example, a peering connection to another VPC network in the same project or to an on-premises network.
VMWARE_ENGINE_NETWORK = 2
Peering connection used for connecting to another VMware Engine network.
PRIVATE_SERVICES_ACCESS = 3
Peering connection used for establishing [private services access](https://cloud.google.com/vpc/docs/private-services-access).
NETAPP_CLOUD_VOLUMES = 4
Peering connection used for connecting to NetApp Cloud Volumes.
THIRD_PARTY_SERVICE = 5
Peering connection used for connecting to third-party services. Most third-party services require manual setup of reverse peering on the VPC network associated with the third-party service.
DELL_POWERSCALE = 6
Peering connection used for connecting to Dell PowerScale Filers
GOOGLE_CLOUD_NETAPP_VOLUMES = 7
Peering connection used for connecting to Google Cloud NetApp Volumes.
Possible states of a network peering.
Used in:
STATE_UNSPECIFIED = 0
Unspecified network peering state. This is the default value.
INACTIVE = 1
The peering is not active.
ACTIVE = 2
The peering is active.
CREATING = 3
The peering is being created.
DELETING = 4
The peering is being deleted.
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.
Used as response type in: VmwareEngine.GetNetworkPolicy
Used as field type in: , ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
optional internet_access = 6
Network service that allows VMware workloads to access the internet.
optional external_ip = 7
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.
string edge_services_cidr = 9
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.
string uid = 10
Output only. System-generated unique identifier for the resource.
string vmware_engine_network = 12
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.
string description = 13
Optional. User-provided description for this network policy.
string vmware_engine_network_canonical = 14
Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}`
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.
Used in:
bool enabled = 1
True if the service is enabled; false otherwise.
NetworkService.State state = 2
Output only. State of the service. New values may be added to this enum when appropriate.
Enum State defines possible states of a network policy controlled service.
Used in:
STATE_UNSPECIFIED = 0
Unspecified service state. This is the default value.
UNPROVISIONED = 1
Service is not provisioned.
RECONCILING = 2
Service is in the process of being provisioned/deprovisioned.
ACTIVE = 3
Service is active.
message
vmwareengine_resources.proto:323Node in a cluster.
Used as response type in: VmwareEngine.GetNode
Used as field type in:
string name = 1
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
string fqdn = 2
Output only. Fully qualified domain name of the node.
string internal_ip = 3
Output only. Internal IP address of the node.
string node_type_id = 4
Output only. The canonical identifier of the node type (corresponds to the `NodeType`). For example: standard-72.
string version = 5
Output only. The version number of the VMware ESXi management component in this cluster.
int64 custom_core_count = 6
Output only. Customized number of cores
Node.State state = 7
Output only. The state of the appliance.
Enum State defines possible states of a node in a cluster.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value should never be used.
ACTIVE = 1
Node is operational and can be used by the user.
CREATING = 2
Node is being provisioned.
FAILED = 3
Node is in a failed state.
UPGRADING = 4
Node is undergoing maintenance, e.g.: during private cloud upgrade.
message
vmwareengine_resources.proto:699Describes node type.
Used as response type in: VmwareEngine.GetNodeType
Used as field type in:
string name = 1
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`
string node_type_id = 2
Output only. The canonical identifier of the node type (corresponds to the `NodeType`). For example: standard-72.
string display_name = 3
Output only. The friendly name for this node type. For example: ve1-standard-72
int32 virtual_cpu_count = 4
Output only. The total number of virtual CPUs in a single node.
int32 total_core_count = 5
Output only. The total number of CPU cores in a single node.
int32 memory_gb = 7
Output only. The amount of physical memory available, defined in GB.
int32 disk_size_gb = 8
Output only. The amount of storage available, defined in GB.
repeated int32 available_custom_core_counts = 11
Output only. List of possible values of custom core count.
NodeType.Kind kind = 12
Output only. The type of the resource.
repeated string families = 13
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`.
repeated NodeType.Capability capabilities = 14
Output only. Capabilities of this node type.
Capability of a node type.
Used in:
CAPABILITY_UNSPECIFIED = 0
The default value. This value is used if the capability is omitted or unknown.
STRETCHED_CLUSTERS = 1
This node type supports stretch clusters.
Enum Kind defines possible types of a NodeType.
Used in:
KIND_UNSPECIFIED = 0
The default value. This value should never be used.
STANDARD = 1
Standard HCI node.
STORAGE_ONLY = 2
Storage only Node.
message
vmwareengine_resources.proto:78Information about the type and number of nodes associated with the cluster.
Used in: ,
int32 node_count = 1
Required. The number of nodes of this type in the cluster
int32 custom_core_count = 2
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.
message
vmwareengine_resources.proto:861Details about a NSX Manager appliance.
Used in:
string internal_ip = 2
Internal IP address of the appliance.
string version = 4
Version of the appliance.
Nsx.State state = 5
Output only. The state of the appliance.
string fqdn = 6
Fully qualified domain name of the appliance.
State of the appliance
Used in:
STATE_UNSPECIFIED = 0
Unspecified appliance state. This is the default value.
ACTIVE = 1
The appliance is operational and can be used.
CREATING = 2
The appliance is being deployed.
message
vmwareengine.proto:2195Represents the metadata of the long-running operation.
optional create_time = 1
Output only. The time the operation was created.
optional end_time = 2
Output only. The time the operation finished running.
string target = 3
Output only. Server-defined resource path for the target of the operation.
string verb = 4
Output only. Name of the verb executed by the operation.
string status_message = 5
Output only. Human-readable status of the operation, if any.
bool requested_cancellation = 6
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][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
string api_version = 7
Output only. API version used to start the operation.
Exchanged network peering route.
Used in: ,
string dest_range = 1
Output only. Destination range of the peering route in CIDR notation.
PeeringRoute.Type type = 2
Output only. Type of the route in the peer VPC network.
string next_hop_region = 3
Output only. Region containing the next hop of the peering route. This field only applies to dynamic routes in the peer VPC network.
int64 priority = 4
Output only. The priority of the peering route.
bool imported = 5
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.
PeeringRoute.Direction direction = 6
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.
The direction of the exchanged routes.
Used in:
DIRECTION_UNSPECIFIED = 0
Unspecified exchanged routes direction. This is default.
INCOMING = 1
Routes imported from the peer network.
OUTGOING = 2
Routes exported to the peer network.
The type of the peering route.
Used in:
TYPE_UNSPECIFIED = 0
Unspecified peering route type. This is the default value.
DYNAMIC_PEERING_ROUTE = 1
Dynamic routes in the peer network.
STATIC_PEERING_ROUTE = 2
Static routes in the peer network.
SUBNET_PEERING_ROUTE = 3
Created, updated, and removed automatically by Google Cloud when subnets are created, modified, or deleted in the peer network.
Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project.
Used in: , ,
oneof principal
The consumer provided user/service account which needs to be granted permission to DNS bind with the intranet VPC corresponding to the consumer project.
string user = 1
The user who needs to be granted permission.
string service_account = 2
The service account which needs to be granted the permission.
message
vmwareengine_resources.proto:119Represents a private cloud resource. Private clouds of type `STANDARD` and `TIME_LIMITED` are zonal resources, `STRETCHED` private clouds are regional.
Used as response type in: VmwareEngine.GetPrivateCloud
Used as field type in: , ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
optional delete_time = 4
Output only. Time when the resource was scheduled for deletion.
optional expire_time = 5
Output only. Time when the resource will be irreversibly deleted.
PrivateCloud.State state = 8
Output only. State of the resource. New values may be added to this enum when appropriate.
optional network_config = 9
Required. Network configuration of the private cloud.
optional management_cluster = 10
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`.
string description = 11
User-provided description for this private cloud.
optional hcx = 17
Output only. HCX appliance.
optional nsx = 18
Output only. NSX appliance.
optional vcenter = 19
Output only. Vcenter appliance.
string uid = 20
Output only. System-generated unique identifier for the resource.
PrivateCloud.Type type = 22
Optional. Type of the private cloud. Defaults to STANDARD.
message
vmwareengine_resources.proto:152Management cluster configuration.
Used in:
string cluster_id = 1
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)
map<string, > node_type_configs = 7
Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`).
optional stretched_cluster_config = 8
Optional. Configuration of a stretched cluster. Required for STRETCHED private clouds.
Enum State defines possible states of private clouds.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value should never be used.
ACTIVE = 1
The private cloud is ready.
CREATING = 2
The private cloud is being created.
UPDATING = 3
The private cloud is being updated.
FAILED = 5
The private cloud is in failed state.
DELETED = 6
The private cloud is scheduled for deletion. The deletion process can be cancelled by using the corresponding undelete method.
PURGING = 7
The private cloud is irreversibly deleted and is being removed from the system.
Enum Type defines private cloud type.
Used in:
STANDARD = 0
Standard private is a zonal resource, with 3+ nodes. Default type.
TIME_LIMITED = 1
Time limited private cloud is a zonal resource, can have only 1 node and has limited life span. Will be deleted after defined period of time, can be converted into standard private cloud by expanding it up to 3 or more nodes.
STRETCHED = 2
Stretched private cloud is a regional resource with redundancy, with a minimum of 6 nodes, nodes count has to be even.
Private connection resource that provides connectivity for VMware Engine private clouds.
Used as response type in: VmwareEngine.GetPrivateConnection
Used as field type in: , ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
string description = 4
Optional. User-provided description for this private connection.
PrivateConnection.State state = 5
Output only. State of the private connection.
string vmware_engine_network = 8
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.
string vmware_engine_network_canonical = 9
Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}`
PrivateConnection.Type type = 10
Required. Private connection type.
string peering_id = 12
Output only. VPC network peering id between given network VPC and VMwareEngineNetwork.
PrivateConnection.RoutingMode routing_mode = 13
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.
string uid = 14
Output only. System-generated unique identifier for the resource.
string service_network = 16
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.
PrivateConnection.PeeringState peering_state = 17
Output only. Peering state between service network and VMware Engine network.
Enum PeeringState defines the possible states of peering between service network and the vpc network peered to service network
Used in:
PEERING_STATE_UNSPECIFIED = 0
The default value. This value is used if the peering state is omitted or unknown.
PEERING_ACTIVE = 1
The peering is in active state.
PEERING_INACTIVE = 2
The peering is in inactive state.
Possible types for RoutingMode
Used in:
ROUTING_MODE_UNSPECIFIED = 0
The default value. This value should never be used.
GLOBAL = 1
Global Routing Mode
REGIONAL = 2
Regional Routing Mode
Enum State defines possible states of private connection.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value is used if the state is omitted.
CREATING = 1
The private connection is being created.
ACTIVE = 2
The private connection is ready.
UPDATING = 3
The private connection is being updated.
DELETING = 4
The private connection is being deleted.
UNPROVISIONED = 5
The private connection is not provisioned, since no private cloud is present for which this private connection is needed.
FAILED = 6
The private connection is in failed state.
Enum Type defines possible types of private connection.
Used in:
TYPE_UNSPECIFIED = 0
The default value. This value should never be used.
PRIVATE_SERVICE_ACCESS = 1
Connection used for establishing [private services access](https://cloud.google.com/vpc/docs/private-services-access).
NETAPP_CLOUD_VOLUMES = 2
Connection used for connecting to NetApp Cloud Volumes.
DELL_POWERSCALE = 3
Connection used for connecting to Dell PowerScale.
THIRD_PARTY_SERVICE = 4
Connection used for connecting to third-party services.
message
vmwareengine_resources.proto:90Configuration of a stretched cluster.
Used in: ,
string preferred_location = 1
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.
string secondary_location = 2
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.
message
vmwareengine_resources.proto:435Subnet in a private cloud. Either `management` subnets (such as vMotion) that are read-only, or `userDefined`, which can also be updated.
Used as response type in: VmwareEngine.GetSubnet
Used as field type in: ,
string name = 1
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`
string ip_cidr_range = 7
The IP address range of the subnet in CIDR format '10.0.0.0/24'.
string gateway_ip = 8
The IP address of the gateway of this subnet. Must fall within the IP prefix defined above.
string type = 11
Output only. The type of the subnet. For example "management" or "userDefined".
Subnet.State state = 13
Output only. The state of the resource.
int32 vlan_id = 16
Output only. VLAN ID of the VLAN on which the subnet is configured
Defines possible states of subnets.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value should never be used.
ACTIVE = 1
The subnet is ready.
CREATING = 2
The subnet is being created.
UPDATING = 3
The subnet is being updated.
DELETING = 4
The subnet is being deleted.
RECONCILING = 5
Changes requested in the last operation are being propagated.
FAILED = 6
Last operation on the subnet did not succeed. Subnet's payload is reverted back to its most recent working state.
message
vmwareengine_resources.proto:888Details about a vCenter Server management appliance.
Used in:
string internal_ip = 2
Internal IP address of the appliance.
string version = 4
Version of the appliance.
Vcenter.State state = 5
Output only. The state of the appliance.
string fqdn = 6
Fully qualified domain name of the appliance.
State of the appliance
Used in:
STATE_UNSPECIFIED = 0
Unspecified appliance state. This is the default value.
ACTIVE = 1
The appliance is operational and can be used.
CREATING = 2
The appliance is being deployed.
VMware Engine network resource that provides connectivity for VMware Engine private clouds.
Used as response type in: VmwareEngine.GetVmwareEngineNetwork
Used as field type in: , ,
string name = 1
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`
optional create_time = 2
Output only. Creation time of this resource.
optional update_time = 3
Output only. Last update time of this resource.
string description = 5
User-provided description for this VMware Engine network.
repeated vpc_networks = 6
Output only. VMware Engine service VPC networks that provide connectivity from a private cloud to customer projects, the internet, and other Google Cloud services.
VmwareEngineNetwork.State state = 7
Output only. State of the VMware Engine network.
VmwareEngineNetwork.Type type = 8
Required. VMware Engine network type.
string uid = 9
Output only. System-generated unique identifier for the resource.
string etag = 10
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.
Enum State defines possible states of VMware Engine network.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value is used if the state is omitted.
CREATING = 1
The VMware Engine network is being created.
ACTIVE = 2
The VMware Engine network is ready.
UPDATING = 3
The VMware Engine network is being updated.
DELETING = 4
The VMware Engine network is being deleted.
Enum Type defines possible types of VMware Engine network.
Used in:
TYPE_UNSPECIFIED = 0
The default value. This value should never be used.
LEGACY = 1
Network type used by private clouds created in projects without a network of type `STANDARD`. This network type is no longer used for new VMware Engine private cloud deployments.
STANDARD = 2
Standard network type used for private cloud connectivity.
Represents a VMware Engine VPC network that is managed by a VMware Engine network resource.
Used in:
VpcNetwork.Type type = 1
Output only. Type of VPC network (INTRANET, INTERNET, or GOOGLE_CLOUD)
string network = 2
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`
Enum Type defines possible types of a VMware Engine network controlled service.
Used in:
TYPE_UNSPECIFIED = 0
The default value. This value should never be used.
INTRANET = 1
VPC network that will be peered with a consumer VPC network or the intranet VPC of another VMware Engine network. Access a private cloud through Compute Engine VMs on a peered VPC network or an on-premises resource connected to a peered consumer VPC network.
INTERNET = 2
VPC network used for internet access to and from a private cloud.
GOOGLE_CLOUD = 3
VPC network used for access to Google Cloud services like Cloud Storage.