2024-09-12
▼ ▲ beyondcorp.projects.locations.securityGateways.setPeering
Path: v1alpha/{+securityGateway}:setPeering
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setPeering
HTTP Method: POST
Parameters:
securityGateway
Description: Required. BeyondCorp SecurityGateway name using the form: `projects/{project}/locations/{location}/securityGateways/{security_gateway}`
Pattern: ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: securityGateway
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers.
▼ ▲ beyondcorp.projects.locations.securityGateways.applications.setIamPolicy
Path: v1alpha/{+resource}:setIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:setIamPolicy
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ beyondcorp.projects.locations.securityGateways.applications.getIamPolicy
Path: v1alpha/{+resource}:getIamPolicy
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:getIamPolicy
HTTP Method: GET
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$
Location: path
Required: Yes
Type: string
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).
Location: query
Type: integer
Format: int32
Parameter Order: resource
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.securityGateways.hubs.list
Path: v1alpha/{+parent}/hubs
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs
HTTP Method: GET
Parameters:
parent
Description: Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. The next_page_token value returned from a previous ListHubsRequest, if any.
Location: query
Type: string
filter
Description: Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName "test-hub" For more information, please refer to https://google.aip.dev/160.
Location: query
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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Hubs in a given project and location.
▼ ▲ beyondcorp.projects.locations.securityGateways.hubs.get
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs/{hubsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Hub using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/hubs/{hub_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/hubs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Hub.
▼ ▲ beyondcorp.projects.locations.securityGateways.hubs.delete
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs/{hubsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/hubs/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
validateOnly
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Hub.
▼ ▲ beyondcorp.projects.locations.global.securityGateways.hubs.create
Path: v1alpha/{+parent}/hubs
Flat Path: v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`
Pattern: ^projects/[^/]+/locations/global/securityGateways/[^/]+$
Location: path
Required: Yes
Type: string
hubId
Description: Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
Location: query
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Hub in a given project and location.
▼ ▲ beyondcorp.projects.locations.global.securityGateways.hubs.patch
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs/{hubsId}
HTTP Method: PATCH
Parameters:
name
Description: Identifier. Name of the resource.
Pattern: ^projects/[^/]+/locations/global/securityGateways/[^/]+/hubs/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Mutable fields include: display_name.
Location: query
Type: string
Format: google-fieldmask
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 the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single Hub.
▼ ▲ beyondcorp.projects.locations.global.securityGateways.hubs.testIamPermissions
Path: v1alpha/{+resource}:testIamPermissions
Flat Path: v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs/{hubsId}: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.
Pattern: ^projects/[^/]+/locations/global/securityGateways/[^/]+/hubs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
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.