2022-05-07
▼ ▲ beyondcorp.projects.locations.appConnections.testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Location: path
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.appConnections.resolve
Parameters:
pageToken
Location: query
Description: Optional. The next_page_token value returned from a previous ResolveAppConnectionsResponse, if any.
Type: string
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Description: Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
appConnectorId
Description: Required. BeyondCorp Connector name of the connector associated with those AppConnections using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
Location: query
Type: string
pageSize
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
Location: query
Path: v1alpha/{+parent}/appConnections:resolve
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections:resolve
Description: Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.
▼ ▲ beyondcorp.projects.locations.appConnections.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
Parameters:
name
Required: Yes
Type: string
Location: path
Description: Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
allowMissing
Type: boolean
Location: query
Description: Optional. If set as true, will create the resource if it is not found.
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.
updateMask
Format: google-fieldmask
Location: query
Type: string
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.AppConnection]: * `labels` * `display_name` * `application_endpoint` * `connectors`
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
Parameter Order: name
HTTP Method: PATCH
Path: v1alpha/{+name}
Description: Updates the parameters of a single AppConnection.
▼ ▲ beyondcorp.projects.locations.appConnections.getIamPolicy
Parameter Order: resource
Parameters:
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
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
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.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Path: v1alpha/{+resource}:getIamPolicy
▼ ▲ beyondcorp.projects.locations.appConnections.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: GET
Path: v1alpha/{+name}
Parameters:
name
Location: path
Description: Required. BeyondCorp AppConnection name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Description: Gets details of a single AppConnection.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
▼ ▲ beyondcorp.projects.locations.appConnections.create
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections
Parameters:
validateOnly
Location: query
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
appConnectionId
Location: query
Description: Optional. User-settable AppConnection 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
requestId
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).
Location: query
parent
Description: Required. The resource project name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Required: Yes
Path: v1alpha/{+parent}/appConnections
Description: Creates a new AppConnection in a given project and location.
▼ ▲ beyondcorp.projects.locations.appConnections.list
Description: Lists AppConnections in a given project and location.
Parameter Order: parent
Parameters:
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.
Type: integer
Format: int32
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
parent
Description: Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
filter
Description: Optional. A filter specifying constraints of a list operation.
Type: string
Location: query
pageToken
Description: Optional. The next_page_token value returned from a previous ListAppConnectionsRequest, if any.
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/appConnections
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appConnections.delete
Path: v1alpha/{+name}
HTTP Method: DELETE
Parameters:
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.
name
Type: string
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Required: Yes
Location: path
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 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).
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single AppConnection.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
▼ ▲ beyondcorp.projects.locations.appConnections.setIamPolicy
HTTP Method: POST
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Type: string
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:setIamPolicy
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.clientGateways.get
Path: v1alpha/{+name}
Description: Gets details of a single ClientGateway.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Required: Yes
Description: Required. Name of the resource
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.clientGateways.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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:setIamPolicy
HTTP Method: POST
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:setIamPolicy
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.clientGateways.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
clientGatewayId
Type: string
Location: query
Description: Optional. User-settable client gateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from (/a-z-/). * Must end with a number or a letter.
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.
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Value for parent.
Type: string
Location: path
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 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).
Description: Creates a new ClientGateway in a given project and location.
Path: v1alpha/{+parent}/clientGateways
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.clientGateways.list
Description: Lists ClientGateways in a given project and location.
Path: v1alpha/{+parent}/clientGateways
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
Parameters:
pageToken
Type: string
Description: Optional. A token identifying a page of results the server should return.
Location: query
orderBy
Description: Optional. Hint for how to order the results.
Type: string
Location: query
filter
Description: Optional. Filtering results.
Location: query
Type: string
parent
Description: Required. Parent value for ListClientGatewaysRequest.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
pageSize
Format: int32
Location: query
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type: integer
HTTP Method: GET
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.clientGateways.delete
Path: v1alpha/{+name}
Parameters:
name
Description: Required. Name of the resource
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
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
requestId
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 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
Description: Deletes a single ClientGateway.
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
▼ ▲ beyondcorp.projects.locations.clientGateways.getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: resource
Path: v1alpha/{+resource}:getIamPolicy
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Location: path
Required: Yes
Type: string
options.requestedPolicyVersion
Type: integer
Location: query
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ beyondcorp.projects.locations.clientGateways.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.
Path: v1alpha/{+resource}:testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions
Parameter Order: resource
Parameters:
resource
Type: string
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
▼ ▲ beyondcorp.projects.locations.operations.get
Parameter Order: name
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Type: string
Description: The name of the operation resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.operations.delete
Parameter Order: name
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters:
name
Required: Yes
Description: The name of the operation resource to be deleted.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.operations.list
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: The name of the operation's parent resource.
Required: Yes
filter
Description: The standard list filter.
Type: string
Location: query
pageSize
Format: int32
Location: query
Type: integer
Description: The standard list page size.
pageToken
Description: The standard list page token.
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
Path: v1alpha/{+name}/operations
▼ ▲ beyondcorp.projects.locations.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Path: v1alpha/{+name}:cancel
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource to be cancelled.
Required: Yes
Type: string
Location: path
Parameter Order: name
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.connections.patch
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: Updates the parameters of a single Connection.
HTTP Method: PATCH
Path: v1alpha/{+name}
Parameters:
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).
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Description: Required. Unique resource name of the connection. The name is ignored when creating a connection.
allowMissing
Type: boolean
Description: Optional. If set as true, will create the resource if it is not found.
Location: query
updateMask
Type: string
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.Connection]: * `labels` * `display_name` * `application_endpoint` * `connectors`
Format: google-fieldmask
Location: query
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
▼ ▲ beyondcorp.projects.locations.connections.get
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Type: string
Required: Yes
Description: Required. BeyondCorp Connection name using the form: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Location: path
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Gets details of a single Connection.
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.connections.delete
Parameters:
name
Type: string
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
validateOnly
Location: query
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
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 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).
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Description: Deletes a single Connection.
Parameter Order: name
Path: v1alpha/{+name}
HTTP Method: DELETE
▼ ▲ beyondcorp.projects.locations.connections.resolve
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections:resolve
Description: Resolves connections details for a given connector. An internal method called by a connector to find connections to connect to.
HTTP Method: GET
Parameters:
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.
connectorId
Type: string
Location: query
Description: Required. BeyondCorp Connector name of the connector associated with those connections using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector_id}`
parent
Location: path
Required: Yes
Type: string
Description: Required. The resource name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Type: string
Description: Optional. The next_page_token value returned from a previous ResolveConnectionsResponse, if any.
Location: query
Path: v1alpha/{+parent}/connections:resolve
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.connections.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
HTTP Method: GET
Description: Lists Connections in a given project and location.
Parameter Order: parent
Path: v1alpha/{+parent}/connections
Parameters:
orderBy
Location: query
Description: Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Type: string
filter
Type: string
Location: query
Description: Optional. A filter specifying constraints of a list operation.
pageSize
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.
Location: query
pageToken
Description: Optional. The next_page_token value returned from a previous ListConnectionsRequest, if any.
Type: string
Location: query
parent
Location: path
Description: Required. The resource name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
▼ ▲ beyondcorp.projects.locations.connections.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
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.
options.requestedPolicyVersion
Location: query
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
HTTP Method: GET
Path: v1alpha/{+resource}:getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.connections.setIamPolicy
Parameter Order: resource
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
resource
Type: string
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.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Path: v1alpha/{+resource}:setIamPolicy
▼ ▲ beyondcorp.projects.locations.connections.testIamPermissions
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Required: Yes
Location: path
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.
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:testIamPermissions
▼ ▲ beyondcorp.projects.locations.connections.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
Description: Creates a new Connection in a given project and location.
Parameters:
requestId
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).
Location: query
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
connectionId
Type: string
Location: query
Description: Optional. User-settable connection resource ID. * Must start with a letter. * Must contain between 4-63 characters from (/a-z-/). * Must end with a number or a letter.
parent
Description: Required. The resource project name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Path: v1alpha/{+parent}/connections
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:getIamPolicy
Parameter Order: resource
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Location: path
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.
options.requestedPolicyVersion
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).
Type: integer
Location: query
Format: int32
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Path: v1alpha/{+resource}:getIamPolicy
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.patch
Description: Updates the parameters of a single ClientConnectorService.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
HTTP Method: PATCH
Parameters:
validateOnly
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Type: boolean
Location: query
updateMask
Location: query
Format: google-fieldmask
Description: Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService 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. Mutable fields: display_name.
Type: string
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).
name
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Description: Required. Name of resource. The name is ignored during creation.
Required: Yes
Location: path
allowMissing
Location: query
Description: Optional. If set as true, will create the resource if it is not found.
Type: boolean
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.testIamPermissions
HTTP Method: POST
Path: v1alpha/{+resource}:testIamPermissions
Parameter Order: resource
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Location: path
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.
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:testIamPermissions
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.create
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
clientConnectorServiceId
Location: query
Type: string
Description: Optional. User-settable client connector service resource ID. * Must start with a letter. * Must contain between 4-63 characters from (/a-z-/). * Must end with a number or a letter. A random system generated name will be assigned if not specified by the user.
parent
Description: Required. Value for parent.
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
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
Description: Creates a new ClientConnectorService in a given project and location.
Path: v1alpha/{+parent}/clientConnectorServices
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.list
HTTP Method: GET
Path: v1alpha/{+parent}/clientConnectorServices
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Parameters:
parent
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Parent value for ListClientConnectorServicesRequest.
Location: path
pageToken
Type: string
Location: query
Description: Optional. A token identifying a page of results the server should return.
pageSize
Type: integer
Location: query
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
orderBy
Location: query
Type: string
Description: Optional. Hint for how to order the results.
filter
Description: Optional. Filtering results.
Type: string
Location: query
Parameter Order: parent
Description: Lists ClientConnectorServices in a given project and location.
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.delete
Description: Deletes a single ClientConnectorService.
Parameter Order: name
HTTP Method: DELETE
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Parameters:
validateOnly
Location: query
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Required: Yes
Location: path
Description: Required. Name of the resource.
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
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
HTTP Method: POST
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
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
Path: v1alpha/{+resource}:setIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.get
Description: Gets details of a single ClientConnectorService.
Path: v1alpha/{+name}
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Required: Yes
Description: Required. Name of the resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.appConnectors.get
Parameters:
name
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Description: Gets details of a single AppConnector.
HTTP Method: GET
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
▼ ▲ beyondcorp.projects.locations.appConnectors.delete
Description: Deletes a single AppConnector.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Parameter Order: name
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
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
name
Required: Yes
Location: path
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Type: string
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
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.appConnectors.resolveInstanceConfig
Parameters:
appConnector
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector}`
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+appConnector}:resolveInstanceConfig
Parameter Order: appConnector
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:resolveInstanceConfig
HTTP Method: GET
Description: Get instance config for a given AppConnector. An internal method called by a AppConnector to get its container config.
▼ ▲ beyondcorp.projects.locations.appConnectors.reportStatus
Parameter Order: appConnector
Path: v1alpha/{+appConnector}:reportStatus
Description: Report status for a given connector.
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:reportStatus
Parameters:
appConnector
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Location: path
▼ ▲ beyondcorp.projects.locations.appConnectors.create
Parameter Order: parent
Description: Creates a new AppConnector in a given project and location.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource project name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`
Location: path
Type: string
Required: Yes
validateOnly
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location: query
appConnectorId
Location: query
Type: string
Description: Optional. User-settable AppConnector resource ID. * Must start with a letter. * Must contain between 4-63 characters from (/a-z-/). * Must end with a number or a letter.
requestId
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).
Location: query
HTTP Method: POST
Path: v1alpha/{+parent}/appConnectors
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors
▼ ▲ beyondcorp.projects.locations.appConnectors.setIamPolicy
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1alpha/{+resource}:setIamPolicy
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:setIamPolicy
Parameters:
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Type: string
Location: path
▼ ▲ beyondcorp.projects.locations.appConnectors.getIamPolicy
Parameters:
resource
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
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
options.requestedPolicyVersion
Location: query
Format: int32
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Path: v1alpha/{+resource}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:getIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appConnectors.patch
Description: Updates the parameters of a single AppConnector.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Path: v1alpha/{+name}
Parameters:
updateMask
Location: query
Type: string
Format: google-fieldmask
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.AppConnector]: * `labels` * `display_name`
validateOnly
Location: query
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
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
name
Type: string
Required: Yes
Description: Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Location: path
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
▼ ▲ beyondcorp.projects.locations.appConnectors.list
Description: Lists AppConnectors in a given project and location.
Path: v1alpha/{+parent}/appConnectors
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors
HTTP Method: GET
Parameter Order: parent
Parameters:
parent
Description: Required. The resource name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
filter
Location: query
Type: string
Description: Optional. A filter specifying constraints of a list operation.
pageSize
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.
Type: integer
Location: query
Format: int32
pageToken
Type: string
Location: query
Description: Optional. The next_page_token value returned from a previous ListAppConnectorsRequest, if any.
orderBy
Location: query
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.
▼ ▲ beyondcorp.projects.locations.appConnectors.testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:testIamPermissions
Parameter Order: resource
Parameters:
resource
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Type: string
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.connectors.testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
HTTP Method: POST
Parameters:
resource
Required: Yes
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.
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ beyondcorp.projects.locations.connectors.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Connector.
Parameters:
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.
name
Required: Yes
Type: string
Location: path
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
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 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).
HTTP Method: DELETE
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
Path: v1alpha/{+name}
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.connectors.getIamPolicy
Parameters:
options.requestedPolicyVersion
Location: query
Type: integer
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
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.
Path: v1alpha/{+resource}:getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameter Order: resource
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.connectors.resolveInstanceConfig
Path: v1alpha/{+connector}:resolveInstanceConfig
Parameter Order: connector
Description: Get instance config for a given connector. An internal method called by a connector to get its container config.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
connector
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Location: path
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:resolveInstanceConfig
▼ ▲ beyondcorp.projects.locations.connectors.get
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
Description: Gets details of a single Connector.
Parameter Order: name
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector_id}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Type: string
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.connectors.create
HTTP Method: POST
Description: Creates a new Connector in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors
Parameters:
requestId
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).
Location: query
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
connectorId
Type: string
Location: query
Description: Optional. User-settable connector resource ID. * Must start with a letter. * Must contain between 4-63 characters from (/a-z-/). * Must end with a number or a letter.
parent
Description: Required. The resource project name of the connector location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Required: Yes
Path: v1alpha/{+parent}/connectors
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.connectors.list
Parameters:
pageToken
Description: Optional. The next_page_token value returned from a previous ListConnectorsRequest, if any.
Type: string
Location: query
pageSize
Format: int32
Location: query
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.
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
filter
Description: Optional. A filter specifying constraints of a list operation.
Location: query
Type: string
parent
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the connector location using the form: `projects/{project_id}/locations/{location_id}`
Description: Lists Connectors in a given project and location.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors
HTTP Method: GET
Path: v1alpha/{+parent}/connectors
▼ ▲ beyondcorp.projects.locations.connectors.reportStatus
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:reportStatus
Parameter Order: connector
HTTP Method: POST
Parameters:
connector
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Description: Report status for a given connector.
Path: v1alpha/{+connector}:reportStatus
▼ ▲ beyondcorp.projects.locations.connectors.patch
Path: v1alpha/{+name}
Parameter Order: name
HTTP Method: PATCH
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
Description: Updates the parameters of a single Connector.
Parameters:
validateOnly
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Type: boolean
Location: query
updateMask
Format: google-fieldmask
Location: query
Type: string
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.Connector]: * `labels` * `display_name`
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
name
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. Unique resource name of the connector. The name is ignored when creating a connector.
▼ ▲ beyondcorp.projects.locations.connectors.setIamPolicy
Path: v1alpha/{+resource}:setIamPolicy
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameter Order: resource
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
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.
▼ ▲ beyondcorp.projects.locations.appGateways.create
Path: v1alpha/{+parent}/appGateways
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways
HTTP Method: POST
Description: Creates a new AppGateway in a given project and location.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
appGatewayId
Location: query
Type: string
Description: Optional. User-settable AppGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from (/a-z-/). * Must end with a number or a letter.
parent
Description: Required. The resource project name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
validateOnly
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
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
▼ ▲ beyondcorp.projects.locations.appGateways.setIamPolicy
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:setIamPolicy
Parameter Order: resource
Parameters:
resource
Type: string
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Location: path
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.appGateways.get
Description: Gets details of a single AppGateway.
Parameter Order: name
Path: v1alpha/{+name}
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Required: Yes
Description: Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
▼ ▲ beyondcorp.projects.locations.appGateways.delete
Parameters:
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
name
Description: Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Location: path
Type: string
requestId
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 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
Description: Deletes a single AppGateway.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}
HTTP Method: DELETE
▼ ▲ beyondcorp.projects.locations.appGateways.list
Parameters:
filter
Description: Optional. A filter specifying constraints of a list operation.
Type: string
Location: query
orderBy
Type: string
Location: query
Description: Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
pageToken
Location: query
Description: Optional. The next_page_token value returned from a previous ListAppGatewaysRequest, if any.
Type: string
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
Location: path
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.
Type: integer
Format: int32
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways
HTTP Method: GET
Description: Lists AppGateways in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/appGateways
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.appGateways.testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions
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.
Path: v1alpha/{+resource}:testIamPermissions
Parameters:
resource
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
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.appGateways.getIamPolicy
Parameter Order: resource
Path: v1alpha/{+resource}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
options.requestedPolicyVersion
Format: int32
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
resource
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Type: string
Required: Yes
Location: path
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.list
Parameters:
pageSize
Description: The maximum number of results to return. If not set, the service selects a default.
Type: integer
Location: query
Format: int32
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+$
Type: string
Description: The resource that owns the locations collection, if applicable.
pageToken
Type: string
Location: query
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
filter
Type: string
Location: query
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Description: Lists information about the supported locations for this service.
Path: v1alpha/{+name}/locations
HTTP Method: GET
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations
▼ ▲ beyondcorp.projects.locations.get
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Description: Resource name for the location.
Description: Gets information about a location.
Path: v1alpha/{+name}
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}