2022-09-28
▼ ▲ beyondcorp.projects.locations.netConnections.create
Parameter Order : parent
HTTP Method : POST
Path : v1alpha/{+parent}/netConnections
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections
Description : Creates a new NetConnection in a given project and location.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
requestId
Location : query
Description : Optional. An optional 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 will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
parent
Type : string
Description : Required. The resource project name of the NetConnection location using the form: `projects/{project_id}/locations/{location_id}`
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
netConnectionId
Description : Optional. User-settable NetConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.
Location : query
Type : string
validateOnly
Type : boolean
Location : query
Description : Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
▼ ▲ beyondcorp.projects.locations.netConnections.get
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
Parameter Order : name
Parameters :
name
Description : Required. BeyondCorp NetConnection name using the form: `projects/{project_id}/locations/{location_id}/netConnections/{net_connection_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Location : path
Required : Yes
Type : string
Description : Gets details of a single NetConnection.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.netConnections.setIamPolicy
Parameter Order : resource
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:setIamPolicy
Path : v1alpha/{+resource}:setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
HTTP Method : POST
▼ ▲ beyondcorp.projects.locations.netConnections.testIamPermissions
Path : v1alpha/{+resource}:testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Parameter Order : resource
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:testIamPermissions
HTTP Method : POST
▼ ▲ beyondcorp.projects.locations.netConnections.delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single NetConnection.
Path : v1alpha/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Description : Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/netConnections/{net_connection_id}`
Required : Yes
Type : string
Location : path
validateOnly
Description : Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location : query
Type : boolean
requestId
Type : string
Location : query
Description : Optional. An optional 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 will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
HTTP Method : DELETE
Parameter Order : name
▼ ▲ beyondcorp.projects.locations.netConnections.list
Parameter Order : parent
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections
HTTP Method : GET
Parameters :
filter
Location : query
Description : Optional. A filter specifying constraints of a list operation.
Type : string
pageSize
Location : query
Description : Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
Format : int32
Type : integer
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Description : Required. The resource name of the NetConnection location using the form: `projects/{project_id}/locations/{location_id}`
pageToken
Description : Optional. The next_page_token value returned from a previous ListNetConnectionsRequest, if any.
Location : query
Type : string
orderBy
Type : string
Description : Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Location : query
Path : v1alpha/{+parent}/netConnections
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists NetConnections in a given project and location.
▼ ▲ beyondcorp.projects.locations.netConnections.patch
Parameter Order : name
Description : Updates the parameters of a single NetConnection.
Parameters :
updateMask
Description : Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.NetConnection]: * `labels` * `display_name`
Format : google-fieldmask
Type : string
Location : query
allowMissing
Description : Optional. If set as true, will create the resource if it is not found.
Type : boolean
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. Unique resource name of the NetConnection. The name is ignored when creating a NetConnection.
requestId
Location : query
Type : string
Description : Optional. An optional 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 will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he 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).
validateOnly
Location : query
Description : Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Type : boolean
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+name}
HTTP Method : PATCH
▼ ▲ beyondcorp.projects.locations.netConnections.getIamPolicy
Parameter Order : resource
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:getIamPolicy
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+resource}:getIamPolicy
Parameters :
options.requestedPolicyVersion
Format : int32
Type : integer
Location : query
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Type : string
Location : path