2022-05-10
▼ ▲ beyondcorp.projects.locations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Gets information about a location.
Parameter Order: name
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Resource name for the location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.list
Description: Lists information about the supported locations for this service.
Parameters:
name
Description: The resource that owns the locations collection, if applicable.
Type: string
Pattern: ^projects/[^/]+$
Required: Yes
Location: path
filter
Location: query
Type: string
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).
pageSize
Type: integer
Location: query
Description: The maximum number of results to return. If not set, the service selects a default.
Format: int32
pageToken
Type: string
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location: query
Flat Path: v1alpha/projects/{projectsId}/locations
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}/locations
HTTP Method: GET
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.appConnections.resolve
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1alpha/{+parent}/appConnections:resolve
Description: Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections:resolve
Parameters:
appConnectorId
Type: string
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
pageToken
Location: query
Type: string
Description: Optional. The next_page_token value returned from a previous ResolveAppConnectionsResponse, if any.
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.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
Required: Yes
Location: path
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.appConnections.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Path: v1alpha/{+resource}:setIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:setIamPolicy
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.
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Required: Yes
Type: string
Location: path
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.appConnections.list
Parameter Order: parent
Path: v1alpha/{+parent}/appConnections
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Location: query
Type: string
Description: Optional. A filter specifying constraints of a list operation.
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
Type: string
Location: path
Required: Yes
Description: Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Description: Optional. The next_page_token value returned from a previous ListAppConnectionsRequest, if any.
Type: string
Location: query
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
Description: Lists AppConnections in a given project and location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections
▼ ▲ beyondcorp.projects.locations.appConnections.patch
Description: Updates the parameters of a single AppConnection.
Path: v1alpha/{+name}
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
Parameters:
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.AppConnection]: * `labels` * `display_name` * `application_endpoint` * `connectors`
Format: google-fieldmask
Location: query
allowMissing
Location: query
Type: boolean
Description: Optional. If set as true, will create the resource if it is not found.
name
Description: Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Location: path
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
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
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
▼ ▲ beyondcorp.projects.locations.appConnections.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single AppConnection.
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
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
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
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
▼ ▲ beyondcorp.projects.locations.appConnections.get
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
Path: v1alpha/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Description: Required. BeyondCorp AppConnection name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
Required: Yes
Type: string
Location: path
Description: Gets details of a single AppConnection.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.appConnections.testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameter Order: resource
Parameters:
resource
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
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.
Location: path
▼ ▲ beyondcorp.projects.locations.appConnections.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}/appConnections/{appConnectionsId}:getIamPolicy
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
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.
Type: string
options.requestedPolicyVersion
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
Format: int32
Path: v1alpha/{+resource}:getIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appConnections.create
Parameter Order: parent
Path: v1alpha/{+parent}/appConnections
Description: Creates a new AppConnection in a given project and location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
appConnectionId
Type: string
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.
Location: query
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
Location: query
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Type: boolean
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource project name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
▼ ▲ beyondcorp.projects.locations.appGateways.setIamPolicy
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/[^/]+/appGateways/[^/]+$
Required: Yes
Location: path
Parameter Order: resource
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:setIamPolicy
Path: v1alpha/{+resource}: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.
▼ ▲ beyondcorp.projects.locations.appGateways.list
HTTP Method: GET
Path: v1alpha/{+parent}/appGateways
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists AppGateways in a given project and location.
Parameter Order: parent
Parameters:
pageToken
Location: query
Type: string
Description: Optional. The next_page_token value returned from a previous ListAppGatewaysRequest, if any.
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
filter
Type: string
Location: query
Description: Optional. A filter specifying constraints of a list operation.
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
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.
▼ ▲ beyondcorp.projects.locations.appGateways.testIamPermissions
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
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
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
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.
▼ ▲ beyondcorp.projects.locations.appGateways.getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:getIamPolicy
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.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Type: string
Location: path
options.requestedPolicyVersion
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).
Type: integer
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
HTTP Method: GET
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.appGateways.get
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}
Path: v1alpha/{+name}
Parameter Order: name
Description: Gets details of a single AppGateway.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Location: path
Description: Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
Required: Yes
Type: string
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appGateways.delete
Description: Deletes a single AppGateway.
HTTP Method: DELETE
Parameter Order: name
Path: v1alpha/{+name}
Parameters:
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
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).
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Location: path
Type: string
Description: Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}
▼ ▲ beyondcorp.projects.locations.appGateways.create
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
Path: v1alpha/{+parent}/appGateways
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
parent
Location: path
Description: Required. The resource project name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
appGatewayId
Type: string
Location: query
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.
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways
▼ ▲ beyondcorp.projects.locations.clientGateways.delete
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single ClientGateway.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
Parameter Order: name
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
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).
name
Required: Yes
Description: Required. Name of the resource
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Location: path
Type: string
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.clientGateways.get
Path: v1alpha/{+name}
Parameter Order: name
Description: Gets details of a single ClientGateway.
HTTP Method: GET
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Description: Required. Name of the resource
Required: Yes
Location: path
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
▼ ▲ beyondcorp.projects.locations.clientGateways.setIamPolicy
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:setIamPolicy
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Required: Yes
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.
Path: v1alpha/{+resource}:setIamPolicy
▼ ▲ beyondcorp.projects.locations.clientGateways.getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}: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.
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.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Required: Yes
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
Parameter Order: resource
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.clientGateways.create
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
Parameters:
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).
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Description: Required. Value for parent.
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
clientGatewayId
Type: string
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.
Location: query
Description: Creates a new ClientGateway in a given project and location.
Parameter Order: parent
Path: v1alpha/{+parent}/clientGateways
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.clientGateways.list
Description: Lists ClientGateways in a given project and location.
Path: v1alpha/{+parent}/clientGateways
Parameters:
pageSize
Type: integer
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Format: int32
filter
Type: string
Description: Optional. Filtering results.
Location: query
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
parent
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Required. Parent value for ListClientGatewaysRequest.
Type: string
pageToken
Type: string
Location: query
Description: Optional. A token identifying a page of results the server should return.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.clientGateways.testIamPermissions
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
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
▼ ▲ beyondcorp.projects.locations.operations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Type: string
Description: The name of the operation resource.
Required: Yes
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
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.
HTTP Method: GET
Path: v1alpha/{+name}
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.operations.delete
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be deleted.
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`.
Parameter Order: name
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.operations.list
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
Description: The name of the operation's parent resource.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Location: query
Type: integer
Description: The standard list page size.
Format: int32
filter
Type: string
Description: The standard list filter.
Location: query
pageToken
Type: string
Location: query
Description: The standard list page token.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}/operations
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.operations.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`.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Parameter Order: name
HTTP Method: POST
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Type: string
Location: path
Description: The name of the operation resource to be cancelled.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}:cancel
▼ ▲ beyondcorp.projects.locations.appConnectors.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
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.
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
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.AppConnector]: * `labels` * `display_name`
Format: google-fieldmask
Location: query
Type: string
name
Description: Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Description: Updates the parameters of a single AppConnector.
Parameter Order: name
HTTP Method: PATCH
▼ ▲ beyondcorp.projects.locations.appConnectors.reportStatus
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:reportStatus
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Report status for a given connector.
Parameters:
appConnector
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Path: v1alpha/{+appConnector}:reportStatus
Parameter Order: appConnector
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.appConnectors.setIamPolicy
Parameters:
resource
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}: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.
HTTP Method: POST
Path: v1alpha/{+resource}:setIamPolicy
▼ ▲ beyondcorp.projects.locations.appConnectors.testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}: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.
HTTP Method: POST
Parameters:
resource
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.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:testIamPermissions
▼ ▲ beyondcorp.projects.locations.appConnectors.delete
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Description: Deletes a single AppConnector.
Path: v1alpha/{+name}
HTTP Method: DELETE
Parameters:
name
Required: Yes
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
Location: path
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
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.appConnectors.list
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: Required. The resource name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
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
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
Description: Optional. The next_page_token value returned from a previous ListAppConnectorsRequest, if any.
Location: query
Type: string
filter
Location: query
Type: string
Description: Optional. A filter specifying constraints of a list operation.
Path: v1alpha/{+parent}/appConnectors
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Lists AppConnectors in a given project and location.
▼ ▲ beyondcorp.projects.locations.appConnectors.get
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
Required: Yes
Path: v1alpha/{+name}
Description: Gets details of a single AppConnector.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appConnectors.create
Parameter Order: parent
Parameters:
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).
Type: string
Location: query
appConnectorId
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.
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. The resource project name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
Description: Creates a new AppConnector in a given project and location.
Path: v1alpha/{+parent}/appConnectors
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors
▼ ▲ beyondcorp.projects.locations.appConnectors.getIamPolicy
Parameter Order: resource
Parameters:
options.requestedPolicyVersion
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).
Format: int32
Type: integer
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/[^/]+/appConnectors/[^/]+$
Type: string
Required: Yes
Location: path
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:getIamPolicy
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appConnectors.resolveInstanceConfig
HTTP Method: GET
Description: Get instance config for a given AppConnector. An internal method called by a AppConnector to get its container config.
Parameters:
appConnector
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector}`
Location: path
Type: string
Path: v1alpha/{+appConnector}:resolveInstanceConfig
Parameter Order: appConnector
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:resolveInstanceConfig
▼ ▲ beyondcorp.projects.locations.connections.getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy
HTTP Method: GET
Path: v1alpha/{+resource}:getIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
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
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.
▼ ▲ beyondcorp.projects.locations.connections.patch
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Description: Updates the parameters of a single Connection.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: PATCH
Path: v1alpha/{+name}
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.Connection]: * `labels` * `display_name` * `application_endpoint` * `connectors`
Location: query
Type: string
Format: google-fieldmask
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Description: Required. Unique resource name of the connection. The name is ignored when creating a connection.
Type: string
allowMissing
Description: Optional. If set as true, will create the resource if it is not found.
Location: query
Type: boolean
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
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
▼ ▲ beyondcorp.projects.locations.connections.create
Description: Creates a new Connection in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource project name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
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).
connectionId
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.
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.
Path: v1alpha/{+parent}/connections
HTTP Method: POST
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
▼ ▲ beyondcorp.projects.locations.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:
connectorId
Description: Required. BeyondCorp Connector name of the connector associated with those connections using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector_id}`
Location: query
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
Location: path
Required: Yes
pageSize
Location: query
Type: integer
Format: int32
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.
pageToken
Location: query
Description: Optional. The next_page_token value returned from a previous ResolveConnectionsResponse, if any.
Type: string
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections:resolve
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/connections:resolve
▼ ▲ beyondcorp.projects.locations.connections.delete
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Connection.
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Parameters:
name
Location: path
Type: string
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Required: Yes
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
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
▼ ▲ beyondcorp.projects.locations.connections.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
Parameters:
pageToken
Location: query
Description: Optional. The next_page_token value returned from a previous ListConnectionsRequest, if any.
Type: string
pageSize
Location: query
Type: integer
Format: int32
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.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
Location: path
Description: Required. The resource name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
orderBy
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
Location: query
filter
Description: Optional. A filter specifying constraints of a list operation.
Type: string
Location: query
Path: v1alpha/{+parent}/connections
Description: Lists Connections in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.connections.setIamPolicy
Parameter Order: resource
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: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.
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.connections.get
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Path: v1alpha/{+name}
Description: Gets details of a single Connection.
Parameters:
name
Type: string
Description: Required. BeyondCorp Connection name using the form: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Required: Yes
Location: path
▼ ▲ beyondcorp.projects.locations.connections.testIamPermissions
Parameters:
resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Required: Yes
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: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.
HTTP Method: POST
Path: v1alpha/{+resource}:testIamPermissions
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Description: Required. Name of the resource.
Description: Gets details of a single ClientConnectorService.
HTTP Method: GET
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
HTTP Method: PATCH
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Parameters:
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
allowMissing
Location: query
Description: Optional. If set as true, will create the resource if it is not found.
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 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
name
Description: Required. Name of resource. The name is ignored during creation.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
updateMask
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.
Location: query
Type: string
Format: google-fieldmask
Description: Updates the parameters of a single ClientConnectorService.
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Path: v1alpha/{+parent}/clientConnectorServices
Description: Lists ClientConnectorServices in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Parameters:
pageSize
Format: int32
Location: query
Type: integer
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
parent
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Parent value for ListClientConnectorServicesRequest.
orderBy
Description: Optional. Hint for how to order the results.
Type: string
Location: query
filter
Type: string
Description: Optional. Filtering results.
Location: query
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.testIamPermissions
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:testIamPermissions
HTTP Method: POST
Path: v1alpha/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
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.
Location: path
Required: Yes
Type: string
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.setIamPolicy
Parameter Order: resource
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.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Required: Yes
Path: v1alpha/{+resource}: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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/clientConnectorServices
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Description: Creates a new ClientConnectorService in a given project and location.
Parameters:
clientConnectorServiceId
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.
Location: query
Type: string
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
parent
Location: path
Required: Yes
Description: Required. Value for parent.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
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).
HTTP Method: POST
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.delete
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Location: path
Required: Yes
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
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
HTTP Method: DELETE
Path: v1alpha/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single ClientConnectorService.
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.getIamPolicy
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: resource
Parameters:
resource
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.
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
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).
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:getIamPolicy
▼ ▲ beyondcorp.projects.locations.connectors.resolveInstanceConfig
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:resolveInstanceConfig
Description: Get instance config for a given connector. An internal method called by a connector to get its container config.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+connector}:resolveInstanceConfig
Parameters:
connector
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Type: string
Location: path
Parameter Order: connector
▼ ▲ beyondcorp.projects.locations.connectors.list
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource name of the connector location using the form: `projects/{project_id}/locations/{location_id}`
Location: path
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
Location: query
Description: Optional. A filter specifying constraints of a list operation.
Type: string
pageToken
Location: query
Type: string
Description: Optional. The next_page_token value returned from a previous ListConnectorsRequest, if any.
pageSize
Format: int32
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
Type: integer
Path: v1alpha/{+parent}/connectors
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Lists Connectors in a given project and location.
▼ ▲ beyondcorp.projects.locations.connectors.setIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Location: path
Required: Yes
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.
Path: v1alpha/{+resource}:setIamPolicy
Parameter Order: resource
HTTP Method: POST
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ beyondcorp.projects.locations.connectors.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single Connector.
Parameter Order: name
HTTP Method: PATCH
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
updateMask
Type: string
Location: query
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.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
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Description: Required. Unique resource name of the connector. The name is ignored when creating a connector.
Required: Yes
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
▼ ▲ beyondcorp.projects.locations.connectors.getIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}: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
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.
Type: string
Location: path
Required: Yes
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}/connectors/{connectorsId}:getIamPolicy
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.connectors.create
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors
Path: v1alpha/{+parent}/connectors
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Connector in a given project and location.
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.
connectorId
Location: query
Type: string
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.
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
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The resource project name of the connector location using the form: `projects/{project_id}/locations/{location_id}`
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.connectors.reportStatus
HTTP Method: POST
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}`
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Parameter Order: connector
Description: Report status for a given connector.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:reportStatus
Path: v1alpha/{+connector}:reportStatus
▼ ▲ beyondcorp.projects.locations.connectors.get
Parameters:
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector_id}`
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
Description: Gets details of a single Connector.
Parameter Order: name
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.connectors.delete
HTTP Method: DELETE
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
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
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector_id}`
Location: path
Required: Yes
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
Description: Deletes a single Connector.
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.connectors.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
Path: v1alpha/{+resource}:testIamPermissions
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:testIamPermissions
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
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.
Location: path
Type: string
HTTP Method: POST