2022-09-29
▼ ▲ beyondcorp.projects.locations.netConnections.get
Parameters:
name
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Description: Required. BeyondCorp NetConnection name using the form: `projects/{project_id}/locations/{location_id}/netConnections/{net_connection_id}`
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single NetConnection.
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.netConnections.list
Parameters:
filter
Type: string
Location: query
Description: Optional. A filter specifying constraints of a list operation.
parent
Location: path
Description: Required. The resource name of the NetConnection location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
pageToken
Description: Optional. The next_page_token value returned from a previous ListNetConnectionsRequest, if any.
Type: string
Location: query
orderBy
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
Type: string
pageSize
Location: query
Format: int32
Type: integer
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.
Description: Lists NetConnections in a given project and location.
HTTP Method: GET
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections
Path: v1alpha/{+parent}/netConnections
▼ ▲ beyondcorp.projects.locations.netConnections.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single NetConnection.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
HTTP Method: DELETE
Path: v1alpha/{+name}
Parameter Order: name
Parameters:
requestId
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).
Location: query
Type: string
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Type: string
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/netConnections/{net_connection_id}`
Location: path
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.testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Type: string
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Location: path
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:testIamPermissions
HTTP Method: POST
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ beyondcorp.projects.locations.netConnections.patch
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
Parameter Order: name
Parameters:
allowMissing
Type: boolean
Description: Optional. If set as true, will create the resource if it is not found.
Location: query
requestId
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).
Location: query
Type: string
updateMask
Location: query
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`
Type: string
Format: google-fieldmask
name
Description: Required. Unique resource name of the NetConnection. The name is ignored when creating a NetConnection.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Type: string
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
Description: Updates the parameters of a single NetConnection.
HTTP Method: PATCH
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.netConnections.create
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Description: Required. The resource project name of the NetConnection location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
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
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.
Type: string
Location: query
requestId
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
Location: query
Description: Creates a new NetConnection in a given project and location.
Path: v1alpha/{+parent}/netConnections
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.netConnections.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
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
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
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:setIamPolicy
Path: v1alpha/{+resource}:setIamPolicy
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.netConnections.getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:getIamPolicy
HTTP Method: GET
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Location: path
options.requestedPolicyVersion
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
Type: integer
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:getIamPolicy
Parameter Order: resource