2024-01-19
▼ ▲ vmwareengine.projects.locations.getDnsBindPermission
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dnsBindPermission
HTTP Method: GET
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/dnsBindPermission$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.networkPeerings.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPeerings/{networkPeeringsId}
HTTP Method: GET
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/networkPeerings/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.networkPeerings.list
Path: v1/{+parent}/networkPeerings
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPeerings
HTTP Method: GET
Parameters:
parent
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: 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.
Location: query
Type: integer
Format: int32
pageToken
Description: 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.
Location: query
Type: string
filter
Description: A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of network 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") ```
Location: query
Type: string
orderBy
Description: Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists `NetworkPeering` resources in a given project. NetworkPeering is a global resource and location can only be global.
▼ ▲ vmwareengine.projects.locations.networkPeerings.create
Path: v1/{+parent}/networkPeerings
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPeerings
HTTP Method: POST
Parameters:
parent
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
networkPeeringId
Description: 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)
Location: query
Type: string
requestId
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.networkPeerings.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPeerings/{networkPeeringsId}
HTTP Method: DELETE
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/networkPeerings/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.networkPeerings.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPeerings/{networkPeeringsId}
HTTP Method: PATCH
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/networkPeerings/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: 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.
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.networkPeerings.peeringRoutes.list
Path: v1/{+parent}/peeringRoutes
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/networkPeerings/{networkPeeringsId}/peeringRoutes
HTTP Method: GET
Parameters:
parent
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/networkPeerings/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
Location: query
Type: integer
Format: int32
pageToken
Description: 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.
Location: query
Type: string
filter
Description: 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.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists the network peering routes exchanged over a peering connection. NetworkPeering is a global resource and location can only be global.
▼ ▲ vmwareengine.projects.locations.dnsBindPermission.grant
Path: v1/{+name}:grant
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dnsBindPermission:grant
HTTP Method: POST
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/dnsBindPermission$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.dnsBindPermission.revoke
Path: v1/{+name}:revoke
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dnsBindPermission:revoke
HTTP Method: POST
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/[^/]+/dnsBindPermission$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.global.getDnsBindPermission
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/global/dnsBindPermission
HTTP Method: GET
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/global/dnsBindPermission$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets all the principals having bind permission on the intranet VPC associated with the consumer project granted by the Grant API.
▼ ▲ vmwareengine.projects.locations.global.networkPeerings.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/global/networkPeerings/{networkPeeringsId}
HTTP Method: GET
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/global/networkPeerings/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.global.networkPeerings.list
Path: v1/{+parent}/networkPeerings
Flat Path: v1/projects/{projectsId}/locations/global/networkPeerings
HTTP Method: GET
Parameters:
parent
Description: 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`
Pattern: ^projects/[^/]+/locations/global$
Location: path
Required: Yes
Type: string
pageSize
Description: 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.
Location: query
Type: integer
Format: int32
pageToken
Description: 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.
Location: query
Type: string
filter
Description: A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of network 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") ```
Location: query
Type: string
orderBy
Description: Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists `NetworkPeering` resources in a given project.
▼ ▲ vmwareengine.projects.locations.global.networkPeerings.create
Path: v1/{+parent}/networkPeerings
Flat Path: v1/projects/{projectsId}/locations/global/networkPeerings
HTTP Method: POST
Parameters:
parent
Description: 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`
Pattern: ^projects/[^/]+/locations/global$
Location: path
Required: Yes
Type: string
networkPeeringId
Description: 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)
Location: query
Type: string
requestId
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new network peering between the peer network and VMware Engine network provided in a `NetworkPeering` resource.
▼ ▲ vmwareengine.projects.locations.global.networkPeerings.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/global/networkPeerings/{networkPeeringsId}
HTTP Method: DELETE
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/global/networkPeerings/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.global.networkPeerings.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/global/networkPeerings/{networkPeeringsId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The resource name of the network peering. 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`
Pattern: ^projects/[^/]+/locations/global/networkPeerings/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: 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.
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Modifies a `NetworkPeering` resource. Only the `description` field can be updated. Only fields specified in `updateMask` are applied.
▼ ▲ vmwareengine.projects.locations.global.networkPeerings.peeringRoutes.list
Path: v1/{+parent}/peeringRoutes
Flat Path: v1/projects/{projectsId}/locations/global/networkPeerings/{networkPeeringsId}/peeringRoutes
HTTP Method: GET
Parameters:
parent
Description: 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`
Pattern: ^projects/[^/]+/locations/global/networkPeerings/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
Location: query
Type: integer
Format: int32
pageToken
Description: 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.
Location: query
Type: string
filter
Description: 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.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists the network peering routes exchanged over a peering connection.
▼ ▲ vmwareengine.projects.locations.global.dnsBindPermission.grant
Path: v1/{+name}:grant
Flat Path: v1/projects/{projectsId}/locations/global/dnsBindPermission:grant
HTTP Method: POST
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/global/dnsBindPermission$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ vmwareengine.projects.locations.global.dnsBindPermission.revoke
Path: v1/{+name}:revoke
Flat Path: v1/projects/{projectsId}/locations/global/dnsBindPermission:revoke
HTTP Method: POST
Parameters:
name
Description: 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`
Pattern: ^projects/[^/]+/locations/global/dnsBindPermission$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Revokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project.