2022-05-09
▼ ▲ beyondcorp.projects.locations.appGateways.setIamPolicy
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
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
Required: Yes
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}: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.
▼ ▲ beyondcorp.projects.locations.appGateways.create
Path: v1alpha/{+parent}/appGateways
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Creates a new AppGateway in a given project and location.
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.
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).
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
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource project name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
▼ ▲ beyondcorp.projects.locations.appGateways.list
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Required. The resource name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Type: string
filter
Type: string
Location: query
Description: Optional. A filter specifying constraints of a list operation.
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
pageToken
Type: string
Description: Optional. The next_page_token value returned from a previous ListAppGatewaysRequest, if any.
Location: query
pageSize
Type: integer
Location: query
Description: Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
Format: int32
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Description: Lists AppGateways in a given project and location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways
Path: v1alpha/{+parent}/appGateways
▼ ▲ beyondcorp.projects.locations.appGateways.getIamPolicy
HTTP Method: GET
Path: v1alpha/{+resource}:getIamPolicy
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:getIamPolicy
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
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
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
▼ ▲ beyondcorp.projects.locations.appGateways.testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions
Parameter Order: resource
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
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
Type: string
▼ ▲ beyondcorp.projects.locations.appGateways.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}
Description: Deletes a single AppGateway.
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Type: string
Location: path
Description: Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
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
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.appGateways.get
Parameter Order: name
Parameters:
name
Location: path
Description: Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Type: string
Required: Yes
Description: Gets details of a single AppGateway.
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.patch
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Description: Required. Name of resource. The name is ignored during creation.
Required: Yes
allowMissing
Description: Optional. If set as true, will create the resource if it is not found.
Type: boolean
Location: query
updateMask
Location: query
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.
Format: google-fieldmask
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
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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single ClientConnectorService.
Path: v1alpha/{+name}
HTTP Method: PATCH
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy
HTTP Method: POST
Path: v1alpha/{+resource}: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.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
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.
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.create
Path: v1alpha/{+parent}/clientConnectorServices
Description: Creates a new ClientConnectorService in a given project and location.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Parameter Order: parent
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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
clientConnectorServiceId
Location: query
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.
Type: string
validateOnly
Location: query
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Type: boolean
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. Value for parent.
Type: string
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}: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
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.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Location: path
Parameter Order: resource
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.getIamPolicy
HTTP Method: GET
Parameter Order: resource
Path: v1alpha/{+resource}:getIamPolicy
Parameters:
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
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}: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.
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.get
Description: Gets details of a single ClientConnectorService.
Parameters:
name
Location: path
Description: Required. Name of the resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Required: Yes
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.list
HTTP Method: GET
Path: v1alpha/{+parent}/clientConnectorServices
Description: Lists ClientConnectorServices in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Parameters:
pageToken
Type: string
Description: Optional. A token identifying a page of results the server should return.
Location: query
pageSize
Location: query
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type: integer
orderBy
Location: query
Description: Optional. Hint for how to order the results.
Type: string
filter
Location: query
Description: Optional. Filtering results.
Type: string
parent
Description: Required. Parent value for ListClientConnectorServicesRequest.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.delete
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single ClientConnectorService.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Required: Yes
Description: Required. Name of the resource.
Type: string
Location: path
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).
Type: string
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
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.appConnectors.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Description: Deletes a single AppConnector.
Path: v1alpha/{+name}
Parameter Order: name
Parameters:
name
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
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 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).
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.
HTTP Method: DELETE
▼ ▲ beyondcorp.projects.locations.appConnectors.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.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
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.
Path: v1alpha/{+resource}:testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:testIamPermissions
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.appConnectors.resolveInstanceConfig
Path: v1alpha/{+appConnector}:resolveInstanceConfig
Parameter Order: appConnector
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:resolveInstanceConfig
Parameters:
appConnector
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector}`
Required: Yes
Location: path
Description: Get instance config for a given AppConnector. An internal method called by a AppConnector to get its container config.
▼ ▲ beyondcorp.projects.locations.appConnectors.setIamPolicy
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:setIamPolicy
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:setIamPolicy
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Type: string
Location: path
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.appConnectors.get
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Description: Gets details of a single AppConnector.
Parameter Order: name
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
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appConnectors.create
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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
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
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.
Type: string
Location: query
parent
Description: Required. The resource project name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors
HTTP Method: POST
Path: v1alpha/{+parent}/appConnectors
Description: Creates a new AppConnector in a given project and location.
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.appConnectors.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
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.
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
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
Format: int32
Location: query
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:getIamPolicy
Path: v1alpha/{+resource}:getIamPolicy
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.appConnectors.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors
Parameter Order: parent
Parameters:
filter
Description: Optional. A filter specifying constraints of a list operation.
Type: string
Location: query
pageToken
Location: query
Type: string
Description: Optional. The next_page_token value returned from a previous ListAppConnectorsRequest, if any.
parent
Location: path
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/[^/]+$
orderBy
Description: Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Location: query
Type: string
pageSize
Location: query
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.
Format: int32
Description: Lists AppConnectors in a given project and location.
Path: v1alpha/{+parent}/appConnectors
▼ ▲ beyondcorp.projects.locations.appConnectors.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Description: Updates the parameters of a single AppConnector.
Parameter Order: name
HTTP Method: PATCH
Path: v1alpha/{+name}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Description: Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
Location: path
Required: Yes
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
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnector]: * `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
▼ ▲ beyondcorp.projects.locations.appConnectors.reportStatus
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:reportStatus
Parameter Order: appConnector
Path: v1alpha/{+appConnector}:reportStatus
Parameters:
appConnector
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Location: path
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Type: string
Description: Report status for a given connector.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.clientGateways.testIamPermissions
Parameter Order: resource
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions
Parameters:
resource
Required: Yes
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.
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
▼ ▲ beyondcorp.projects.locations.clientGateways.create
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
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
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
Description: Required. Value for parent.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
clientGatewayId
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
Type: string
Path: v1alpha/{+parent}/clientGateways
Parameter Order: parent
Description: Creates a new ClientGateway in a given project and location.
▼ ▲ beyondcorp.projects.locations.clientGateways.list
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
Parameters:
orderBy
Location: query
Type: string
Description: Optional. Hint for how to order the results.
pageSize
Location: query
Type: integer
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken
Location: query
Description: Optional. A token identifying a page of results the server should return.
Type: string
filter
Type: string
Location: query
Description: Optional. Filtering results.
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: Required. Parent value for ListClientGatewaysRequest.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists ClientGateways in a given project and location.
Path: v1alpha/{+parent}/clientGateways
▼ ▲ beyondcorp.projects.locations.clientGateways.get
Description: Gets details of a single ClientGateway.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Type: string
Description: Required. Name of the resource
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Parameter Order: name
HTTP Method: GET
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.clientGateways.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.
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
name
Description: Required. Name of the resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Required: Yes
Location: path
Path: v1alpha/{+name}
Description: Deletes a single ClientGateway.
HTTP Method: DELETE
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
▼ ▲ beyondcorp.projects.locations.clientGateways.setIamPolicy
Parameters:
resource
Location: path
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.
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}: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.
Parameter Order: resource
Path: v1alpha/{+resource}:setIamPolicy
▼ ▲ beyondcorp.projects.locations.clientGateways.getIamPolicy
Parameters:
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Location: path
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
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:getIamPolicy
Path: v1alpha/{+resource}:getIamPolicy
▼ ▲ beyondcorp.projects.locations.connections.testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions
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.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
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.connections.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Parameters:
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.Connection]: * `labels` * `display_name` * `application_endpoint` * `connectors`
allowMissing
Location: query
Description: Optional. If set as true, will create the resource if it is not found.
Type: boolean
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
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Description: Required. Unique resource name of the connection. The name is ignored when creating a connection.
Location: path
validateOnly
Type: boolean
Location: query
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Description: Updates the parameters of a single Connection.
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.connections.resolve
Parameters:
pageToken
Type: string
Location: query
Description: Optional. The next_page_token value returned from a previous ResolveConnectionsResponse, if any.
pageSize
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.
Location: query
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}`
Type: string
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Type: string
Location: path
Description: Resolves connections details for a given connector. An internal method called by a connector to find connections to connect to.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Path: v1alpha/{+parent}/connections:resolve
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections:resolve
▼ ▲ beyondcorp.projects.locations.connections.getIamPolicy
Parameter Order: resource
Path: v1alpha/{+resource}:getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: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.
HTTP Method: GET
Parameters:
options.requestedPolicyVersion
Format: int32
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).
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Type: string
▼ ▲ beyondcorp.projects.locations.connections.create
HTTP Method: POST
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
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
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource project name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
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 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
Path: v1alpha/{+parent}/connections
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
Description: Creates a new Connection in a given project and location.
▼ ▲ beyondcorp.projects.locations.connections.setIamPolicy
HTTP Method: POST
Parameters:
resource
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.
Location: path
Type: string
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.connections.delete
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 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
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Type: string
Location: path
Required: Yes
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Parameter Order: name
Path: v1alpha/{+name}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Connection.
▼ ▲ beyondcorp.projects.locations.connections.list
HTTP Method: GET
Parameters:
pageSize
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
Format: int32
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The resource name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
filter
Type: string
Description: Optional. A filter specifying constraints of a list operation.
Location: query
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.
pageToken
Description: Optional. The next_page_token value returned from a previous ListConnectionsRequest, if any.
Type: string
Location: query
Path: v1alpha/{+parent}/connections
Description: Lists Connections in a given project and location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.connections.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Parameter Order: name
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Required: Yes
Description: Required. BeyondCorp Connection name using the form: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Location: path
Type: string
Description: Gets details of a single Connection.
▼ ▲ beyondcorp.projects.locations.appConnections.testIamPermissions
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/[^/]+/appConnections/[^/]+$
HTTP Method: POST
Path: v1alpha/{+resource}: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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:testIamPermissions
▼ ▲ beyondcorp.projects.locations.appConnections.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
HTTP Method: GET
Description: Gets details of a single AppConnection.
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Description: Required. BeyondCorp AppConnection name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
Location: path
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
▼ ▲ beyondcorp.projects.locations.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:
pageToken
Type: string
Location: query
Description: Optional. The next_page_token value returned from a previous ResolveAppConnectionsResponse, if any.
parent
Description: Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
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}`
Type: string
Location: query
pageSize
Location: query
Description: Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
Format: int32
Type: integer
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1alpha/{+parent}/appConnections:resolve
▼ ▲ beyondcorp.projects.locations.appConnections.delete
Parameters:
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/[^/]+$
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).
Type: string
Location: query
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.
Description: Deletes a single AppConnection.
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
Parameter Order: name
HTTP Method: DELETE
▼ ▲ beyondcorp.projects.locations.appConnections.getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:getIamPolicy
Path: v1alpha/{+resource}:getIamPolicy
HTTP Method: GET
Parameters:
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
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Type: string
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.
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.
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.appConnections.list
Path: v1alpha/{+parent}/appConnections
Description: Lists AppConnections in a given project and location.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Description: Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
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
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.
Format: int32
Location: query
Type: integer
pageToken
Description: Optional. The next_page_token value returned from a previous ListAppConnectionsRequest, if any.
Location: query
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections
HTTP Method: GET
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.appConnections.setIamPolicy
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:setIamPolicy
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.
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Type: string
Location: path
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
▼ ▲ beyondcorp.projects.locations.appConnections.patch
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
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.AppConnection]: * `labels` * `display_name` * `application_endpoint` * `connectors`
Type: string
Location: query
Format: google-fieldmask
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. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Required: Yes
Location: path
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
allowMissing
Type: boolean
Description: Optional. If set as true, will create the resource if it is not found.
Location: query
Description: Updates the parameters of a single AppConnection.
▼ ▲ beyondcorp.projects.locations.appConnections.create
Path: v1alpha/{+parent}/appConnections
Parameter Order: parent
Description: Creates a new AppConnection in a given project and location.
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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
Description: Required. The resource project name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
appConnectionId
Location: query
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.
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.operations.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations
Parameters:
pageToken
Description: The standard list page token.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
filter
Type: string
Location: query
Description: The standard list filter.
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: The name of the operation's parent resource.
Path: v1alpha/{+name}/operations
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ beyondcorp.projects.locations.operations.get
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.
Path: v1alpha/{+name}
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Type: string
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
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`.
Parameter Order: name
Parameters:
name
Description: The name of the operation resource to be cancelled.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method: POST
Path: v1alpha/{+name}:cancel
▼ ▲ beyondcorp.projects.locations.operations.delete
Path: v1alpha/{+name}
Parameters:
name
Required: Yes
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
HTTP Method: DELETE
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ beyondcorp.projects.locations.connectors.patch
Description: Updates the parameters of a single Connector.
HTTP Method: PATCH
Parameter Order: name
Path: v1alpha/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Required: Yes
Description: Required. Unique resource name of the connector. The name is ignored when creating a connector.
Location: path
Type: string
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.Connector]: * `labels` * `display_name`
Location: query
Type: string
Format: google-fieldmask
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
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
▼ ▲ beyondcorp.projects.locations.connectors.delete
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
Path: v1alpha/{+name}
Description: Deletes a single Connector.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
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 after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
name
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector_id}`
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
▼ ▲ beyondcorp.projects.locations.connectors.resolveInstanceConfig
HTTP Method: GET
Parameter Order: connector
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.
Path: v1alpha/{+connector}:resolveInstanceConfig
Parameters:
connector
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
▼ ▲ beyondcorp.projects.locations.connectors.testIamPermissions
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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:testIamPermissions
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
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Type: string
Required: Yes
Parameter Order: resource
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.connectors.reportStatus
Description: Report status for a given connector.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+connector}:reportStatus
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:reportStatus
HTTP Method: POST
Parameter Order: connector
Parameters:
connector
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Required: Yes
▼ ▲ beyondcorp.projects.locations.connectors.create
HTTP Method: POST
Path: v1alpha/{+parent}/connectors
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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
Type: string
Description: Required. The resource project name of the connector location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
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.
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Connector in a given project and location.
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors
▼ ▲ 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
Path: v1alpha/{+name}
Parameter Order: name
Description: Gets details of a single Connector.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
▼ ▲ beyondcorp.projects.locations.connectors.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors
HTTP Method: GET
Description: Lists Connectors in a given project and location.
Parameters:
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.
Location: query
Type: integer
Format: int32
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.
parent
Location: path
Description: Required. The resource name of the connector location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
pageToken
Description: Optional. The next_page_token value returned from a previous ListConnectorsRequest, if any.
Type: string
Location: query
filter
Description: Optional. A filter specifying constraints of a list operation.
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1alpha/{+parent}/connectors
▼ ▲ beyondcorp.projects.locations.connectors.setIamPolicy
HTTP Method: POST
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
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}/connectors/{connectorsId}:setIamPolicy
▼ ▲ beyondcorp.projects.locations.connectors.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:getIamPolicy
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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:getIamPolicy
Parameters:
options.requestedPolicyVersion
Type: integer
Location: query
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
resource
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Required: Yes
Type: string
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.
▼ ▲ beyondcorp.projects.locations.list
Parameters:
pageToken
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type: string
Location: query
filter
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).
Location: query
name
Location: path
Type: string
Required: Yes
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
pageSize
Location: query
Description: The maximum number of results to return. If not set, the service selects a default.
Type: integer
Format: int32
Path: v1alpha/{+name}/locations
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists information about the supported locations for this service.
▼ ▲ beyondcorp.projects.locations.get
Description: Gets information about a location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Parameters:
name
Location: path
Description: Resource name for the location.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appGateways.setIamPolicy
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
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
Required: Yes
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}: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.
▼ ▲ beyondcorp.projects.locations.appGateways.create
Path: v1alpha/{+parent}/appGateways
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Creates a new AppGateway in a given project and location.
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.
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).
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
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The resource project name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
▼ ▲ beyondcorp.projects.locations.appGateways.list
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Description: Required. The resource name of the AppGateway location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Type: string
filter
Type: string
Location: query
Description: Optional. A filter specifying constraints of a list operation.
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
pageToken
Type: string
Description: Optional. The next_page_token value returned from a previous ListAppGatewaysRequest, if any.
Location: query
pageSize
Type: integer
Location: query
Description: Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
Format: int32
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Description: Lists AppGateways in a given project and location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways
Path: v1alpha/{+parent}/appGateways
▼ ▲ beyondcorp.projects.locations.appGateways.getIamPolicy
HTTP Method: GET
Path: v1alpha/{+resource}:getIamPolicy
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:getIamPolicy
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
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
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
▼ ▲ beyondcorp.projects.locations.appGateways.testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions
Parameter Order: resource
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
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
Type: string
▼ ▲ beyondcorp.projects.locations.appGateways.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}
Description: Deletes a single AppGateway.
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Type: string
Location: path
Description: Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
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
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.appGateways.get
Parameter Order: name
Parameters:
name
Location: path
Description: Required. BeyondCorp AppGateway name using the form: `projects/{project_id}/locations/{location_id}/appGateways/{app_gateway_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$
Type: string
Required: Yes
Description: Gets details of a single AppGateway.
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.patch
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Description: Required. Name of resource. The name is ignored during creation.
Required: Yes
allowMissing
Description: Optional. If set as true, will create the resource if it is not found.
Type: boolean
Location: query
updateMask
Location: query
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.
Format: google-fieldmask
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
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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single ClientConnectorService.
Path: v1alpha/{+name}
HTTP Method: PATCH
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}:setIamPolicy
HTTP Method: POST
Path: v1alpha/{+resource}: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.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
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.
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.create
Path: v1alpha/{+parent}/clientConnectorServices
Description: Creates a new ClientConnectorService in a given project and location.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Parameter Order: parent
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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
clientConnectorServiceId
Location: query
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.
Type: string
validateOnly
Location: query
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Type: boolean
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. Value for parent.
Type: string
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}: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
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.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Location: path
Parameter Order: resource
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.getIamPolicy
HTTP Method: GET
Parameter Order: resource
Path: v1alpha/{+resource}:getIamPolicy
Parameters:
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
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Type: string
Location: path
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}: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.
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.get
Description: Gets details of a single ClientConnectorService.
Parameters:
name
Location: path
Description: Required. Name of the resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Required: Yes
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.list
HTTP Method: GET
Path: v1alpha/{+parent}/clientConnectorServices
Description: Lists ClientConnectorServices in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Parameters:
pageToken
Type: string
Description: Optional. A token identifying a page of results the server should return.
Location: query
pageSize
Location: query
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type: integer
orderBy
Location: query
Description: Optional. Hint for how to order the results.
Type: string
filter
Location: query
Description: Optional. Filtering results.
Type: string
parent
Description: Required. Parent value for ListClientConnectorServicesRequest.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.delete
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single ClientConnectorService.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Required: Yes
Description: Required. Name of the resource.
Type: string
Location: path
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).
Type: string
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
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.appConnectors.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Description: Deletes a single AppConnector.
Path: v1alpha/{+name}
Parameter Order: name
Parameters:
name
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
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 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).
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.
HTTP Method: DELETE
▼ ▲ beyondcorp.projects.locations.appConnectors.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.
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
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.
Path: v1alpha/{+resource}:testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:testIamPermissions
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.appConnectors.resolveInstanceConfig
Path: v1alpha/{+appConnector}:resolveInstanceConfig
Parameter Order: appConnector
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:resolveInstanceConfig
Parameters:
appConnector
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Description: Required. BeyondCorp AppConnector name using the form: `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector}`
Required: Yes
Location: path
Description: Get instance config for a given AppConnector. An internal method called by a AppConnector to get its container config.
▼ ▲ beyondcorp.projects.locations.appConnectors.setIamPolicy
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:setIamPolicy
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:setIamPolicy
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Type: string
Location: path
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.appConnectors.get
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Description: Gets details of a single AppConnector.
Parameter Order: name
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
HTTP Method: GET
▼ ▲ beyondcorp.projects.locations.appConnectors.create
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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
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
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.
Type: string
Location: query
parent
Description: Required. The resource project name of the AppConnector location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors
HTTP Method: POST
Path: v1alpha/{+parent}/appConnectors
Description: Creates a new AppConnector in a given project and location.
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.appConnectors.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
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.
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
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
Format: int32
Location: query
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:getIamPolicy
Path: v1alpha/{+resource}:getIamPolicy
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.appConnectors.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors
Parameter Order: parent
Parameters:
filter
Description: Optional. A filter specifying constraints of a list operation.
Type: string
Location: query
pageToken
Location: query
Type: string
Description: Optional. The next_page_token value returned from a previous ListAppConnectorsRequest, if any.
parent
Location: path
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/[^/]+$
orderBy
Description: Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Location: query
Type: string
pageSize
Location: query
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.
Format: int32
Description: Lists AppConnectors in a given project and location.
Path: v1alpha/{+parent}/appConnectors
▼ ▲ beyondcorp.projects.locations.appConnectors.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}
Description: Updates the parameters of a single AppConnector.
Parameter Order: name
HTTP Method: PATCH
Path: v1alpha/{+name}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Description: Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
Location: path
Required: Yes
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
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnector]: * `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
▼ ▲ beyondcorp.projects.locations.appConnectors.reportStatus
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnectors/{appConnectorsId}:reportStatus
Parameter Order: appConnector
Path: v1alpha/{+appConnector}:reportStatus
Parameters:
appConnector
Pattern: ^projects/[^/]+/locations/[^/]+/appConnectors/[^/]+$
Location: path
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Type: string
Description: Report status for a given connector.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.clientGateways.testIamPermissions
Parameter Order: resource
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:testIamPermissions
Parameters:
resource
Required: Yes
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.
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
▼ ▲ beyondcorp.projects.locations.clientGateways.create
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
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
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
Description: Required. Value for parent.
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
clientGatewayId
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
Type: string
Path: v1alpha/{+parent}/clientGateways
Parameter Order: parent
Description: Creates a new ClientGateway in a given project and location.
▼ ▲ beyondcorp.projects.locations.clientGateways.list
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
Parameters:
orderBy
Location: query
Type: string
Description: Optional. Hint for how to order the results.
pageSize
Location: query
Type: integer
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken
Location: query
Description: Optional. A token identifying a page of results the server should return.
Type: string
filter
Type: string
Location: query
Description: Optional. Filtering results.
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: Required. Parent value for ListClientGatewaysRequest.
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists ClientGateways in a given project and location.
Path: v1alpha/{+parent}/clientGateways
▼ ▲ beyondcorp.projects.locations.clientGateways.get
Description: Gets details of a single ClientGateway.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Type: string
Description: Required. Name of the resource
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Parameter Order: name
HTTP Method: GET
Path: v1alpha/{+name}
▼ ▲ beyondcorp.projects.locations.clientGateways.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.
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
name
Description: Required. Name of the resource
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Required: Yes
Location: path
Path: v1alpha/{+name}
Description: Deletes a single ClientGateway.
HTTP Method: DELETE
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
▼ ▲ beyondcorp.projects.locations.clientGateways.setIamPolicy
Parameters:
resource
Location: path
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.
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}: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.
Parameter Order: resource
Path: v1alpha/{+resource}:setIamPolicy
▼ ▲ beyondcorp.projects.locations.clientGateways.getIamPolicy
Parameters:
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Location: path
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
Parameter Order: resource
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}:getIamPolicy
Path: v1alpha/{+resource}:getIamPolicy
▼ ▲ beyondcorp.projects.locations.connections.testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:testIamPermissions
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.
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
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.connections.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
Parameters:
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.Connection]: * `labels` * `display_name` * `application_endpoint` * `connectors`
allowMissing
Location: query
Description: Optional. If set as true, will create the resource if it is not found.
Type: boolean
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
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Description: Required. Unique resource name of the connection. The name is ignored when creating a connection.
Location: path
validateOnly
Type: boolean
Location: query
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Description: Updates the parameters of a single Connection.
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.connections.resolve
Parameters:
pageToken
Type: string
Location: query
Description: Optional. The next_page_token value returned from a previous ResolveConnectionsResponse, if any.
pageSize
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.
Location: query
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}`
Type: string
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Type: string
Location: path
Description: Resolves connections details for a given connector. An internal method called by a connector to find connections to connect to.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
Path: v1alpha/{+parent}/connections:resolve
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections:resolve
▼ ▲ beyondcorp.projects.locations.connections.getIamPolicy
Parameter Order: resource
Path: v1alpha/{+resource}:getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: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.
HTTP Method: GET
Parameters:
options.requestedPolicyVersion
Format: int32
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).
resource
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Type: string
▼ ▲ beyondcorp.projects.locations.connections.create
HTTP Method: POST
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
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
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The resource project name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
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 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
Path: v1alpha/{+parent}/connections
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
Description: Creates a new Connection in a given project and location.
▼ ▲ beyondcorp.projects.locations.connections.setIamPolicy
HTTP Method: POST
Parameters:
resource
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.
Location: path
Type: string
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.connections.delete
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 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
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Type: string
Location: path
Required: Yes
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Parameter Order: name
Path: v1alpha/{+name}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Connection.
▼ ▲ beyondcorp.projects.locations.connections.list
HTTP Method: GET
Parameters:
pageSize
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
Format: int32
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The resource name of the connection location using the form: `projects/{project_id}/locations/{location_id}`
filter
Type: string
Description: Optional. A filter specifying constraints of a list operation.
Location: query
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.
pageToken
Description: Optional. The next_page_token value returned from a previous ListConnectionsRequest, if any.
Type: string
Location: query
Path: v1alpha/{+parent}/connections
Description: Lists Connections in a given project and location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.connections.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Parameter Order: name
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Required: Yes
Description: Required. BeyondCorp Connection name using the form: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Location: path
Type: string
Description: Gets details of a single Connection.
▼ ▲ beyondcorp.projects.locations.appConnections.testIamPermissions
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/[^/]+/appConnections/[^/]+$
HTTP Method: POST
Path: v1alpha/{+resource}: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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:testIamPermissions
▼ ▲ beyondcorp.projects.locations.appConnections.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
HTTP Method: GET
Description: Gets details of a single AppConnection.
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Description: Required. BeyondCorp AppConnection name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`
Location: path
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
▼ ▲ beyondcorp.projects.locations.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:
pageToken
Type: string
Location: query
Description: Optional. The next_page_token value returned from a previous ResolveAppConnectionsResponse, if any.
parent
Description: Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
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}`
Type: string
Location: query
pageSize
Location: query
Description: Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
Format: int32
Type: integer
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1alpha/{+parent}/appConnections:resolve
▼ ▲ beyondcorp.projects.locations.appConnections.delete
Parameters:
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/[^/]+$
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).
Type: string
Location: query
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.
Description: Deletes a single AppConnection.
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
Parameter Order: name
HTTP Method: DELETE
▼ ▲ beyondcorp.projects.locations.appConnections.getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:getIamPolicy
Path: v1alpha/{+resource}:getIamPolicy
HTTP Method: GET
Parameters:
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
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Type: string
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.
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.
Parameter Order: resource
▼ ▲ beyondcorp.projects.locations.appConnections.list
Path: v1alpha/{+parent}/appConnections
Description: Lists AppConnections in a given project and location.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Description: Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
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
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.
Format: int32
Location: query
Type: integer
pageToken
Description: Optional. The next_page_token value returned from a previous ListAppConnectionsRequest, if any.
Location: query
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections
HTTP Method: GET
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.appConnections.setIamPolicy
Parameter Order: resource
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}:setIamPolicy
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.
Path: v1alpha/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Type: string
Location: path
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
▼ ▲ beyondcorp.projects.locations.appConnections.patch
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections/{appConnectionsId}
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: PATCH
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.AppConnection]: * `labels` * `display_name` * `application_endpoint` * `connectors`
Type: string
Location: query
Format: google-fieldmask
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. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.
Pattern: ^projects/[^/]+/locations/[^/]+/appConnections/[^/]+$
Required: Yes
Location: path
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
allowMissing
Type: boolean
Description: Optional. If set as true, will create the resource if it is not found.
Location: query
Description: Updates the parameters of a single AppConnection.
▼ ▲ beyondcorp.projects.locations.appConnections.create
Path: v1alpha/{+parent}/appConnections
Parameter Order: parent
Description: Creates a new AppConnection in a given project and location.
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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
Description: Required. The resource project name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
appConnectionId
Location: query
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.
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/appConnections
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.operations.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations
Parameters:
pageToken
Description: The standard list page token.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
filter
Type: string
Location: query
Description: The standard list filter.
name
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: The name of the operation's parent resource.
Path: v1alpha/{+name}/operations
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ beyondcorp.projects.locations.operations.get
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.
Path: v1alpha/{+name}
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Type: string
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
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`.
Parameter Order: name
Parameters:
name
Description: The name of the operation resource to be cancelled.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method: POST
Path: v1alpha/{+name}:cancel
▼ ▲ beyondcorp.projects.locations.operations.delete
Path: v1alpha/{+name}
Parameters:
name
Required: Yes
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
HTTP Method: DELETE
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
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ beyondcorp.projects.locations.connectors.patch
Description: Updates the parameters of a single Connector.
HTTP Method: PATCH
Parameter Order: name
Path: v1alpha/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Required: Yes
Description: Required. Unique resource name of the connector. The name is ignored when creating a connector.
Location: path
Type: string
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.Connector]: * `labels` * `display_name`
Location: query
Type: string
Format: google-fieldmask
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
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
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
▼ ▲ beyondcorp.projects.locations.connectors.delete
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
Path: v1alpha/{+name}
Description: Deletes a single Connector.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
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 after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
name
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector_id}`
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
▼ ▲ beyondcorp.projects.locations.connectors.resolveInstanceConfig
HTTP Method: GET
Parameter Order: connector
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.
Path: v1alpha/{+connector}:resolveInstanceConfig
Parameters:
connector
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
▼ ▲ beyondcorp.projects.locations.connectors.testIamPermissions
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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:testIamPermissions
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
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Type: string
Required: Yes
Parameter Order: resource
HTTP Method: POST
▼ ▲ beyondcorp.projects.locations.connectors.reportStatus
Description: Report status for a given connector.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+connector}:reportStatus
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:reportStatus
HTTP Method: POST
Parameter Order: connector
Parameters:
connector
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/connectors/{connector}`
Required: Yes
▼ ▲ beyondcorp.projects.locations.connectors.create
HTTP Method: POST
Path: v1alpha/{+parent}/connectors
Parameters:
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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
Type: string
Description: Required. The resource project name of the connector location using the form: `projects/{project_id}/locations/{location_id}`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
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.
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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Connector in a given project and location.
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors
▼ ▲ 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
Path: v1alpha/{+name}
Parameter Order: name
Description: Gets details of a single Connector.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}
▼ ▲ beyondcorp.projects.locations.connectors.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors
HTTP Method: GET
Description: Lists Connectors in a given project and location.
Parameters:
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.
Location: query
Type: integer
Format: int32
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.
parent
Location: path
Description: Required. The resource name of the connector location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Required: Yes
pageToken
Description: Optional. The next_page_token value returned from a previous ListConnectorsRequest, if any.
Type: string
Location: query
filter
Description: Optional. A filter specifying constraints of a list operation.
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1alpha/{+parent}/connectors
▼ ▲ beyondcorp.projects.locations.connectors.setIamPolicy
HTTP Method: POST
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
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}/connectors/{connectorsId}:setIamPolicy
▼ ▲ beyondcorp.projects.locations.connectors.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+resource}:getIamPolicy
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.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/connectors/{connectorsId}:getIamPolicy
Parameters:
options.requestedPolicyVersion
Type: integer
Location: query
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
resource
Pattern: ^projects/[^/]+/locations/[^/]+/connectors/[^/]+$
Required: Yes
Type: string
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.
▼ ▲ beyondcorp.projects.locations.list
Parameters:
pageToken
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type: string
Location: query
filter
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).
Location: query
name
Location: path
Type: string
Required: Yes
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
pageSize
Location: query
Description: The maximum number of results to return. If not set, the service selects a default.
Type: integer
Format: int32
Path: v1alpha/{+name}/locations
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists information about the supported locations for this service.
▼ ▲ beyondcorp.projects.locations.get
Description: Gets information about a location.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Parameters:
name
Location: path
Description: Resource name for the location.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
HTTP Method: GET