2023-06-24
▼ ▲ beyondcorp.organizations.locations.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations
HTTP Method: GET
Parameter Order: name
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation's parent resource.
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Format: int32
Location: query
Description: The standard list page size.
Type: integer
▼ ▲ beyondcorp.organizations.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.
Parameter Order: name
Path: v1alpha/{+name}
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
name
Pattern: ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Required: Yes
Location: path
Type: string
Description: The name of the operation resource.
▼ ▲ beyondcorp.organizations.locations.operations.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: The name of the operation resource to be deleted.
Type: string
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Parameter Order: name
Path: v1alpha/{+name}
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE
▼ ▲ beyondcorp.organizations.locations.operations.cancel
Parameter Order: name
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel
Parameters:
name
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource to be cancelled.
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Path: v1alpha/{+name}:cancel
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.create
Description: Creates a new ClientConnectorService in a given project and location.
Parameters:
parent
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Value for parent.
requestId
Location: query
Type: string
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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).
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
clientConnectorServiceId
Description: Optional. User-settable client connector service resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter. A random system generated name will be assigned if not specified by the user.
Type: string
Location: query
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/clientConnectorServices
HTTP Method: POST
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.get
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Location: path
Description: Required. Name of the resource.
Required: Yes
Type: string
Path: v1alpha/{+name}
Description: Gets details of a single ClientConnectorService.
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.patch
Description: Updates the parameters of a single ClientConnectorService.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
requestId
Type: string
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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).
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.
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Mutable fields: display_name, ingress.config.destination_routes.
Format: google-fieldmask
Location: query
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Location: path
Required: Yes
Description: Required. Name of resource. The name is ignored during creation.
Type: string
allowMissing
Type: boolean
Location: query
Description: Optional. If set as true, will create the resource if it is not found.
Path: v1alpha/{+name}
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
HTTP Method: PATCH
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.delete
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 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).
Type: string
Location: query
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/clientConnectorServices/[^/]+$
Description: Required. Name of the resource.
Required: Yes
Location: path
validateOnly
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location: query
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices/{clientConnectorServicesId}
Path: v1alpha/{+name}
Description: Deletes a single ClientConnectorService.
▼ ▲ beyondcorp.projects.locations.clientConnectorServices.list
Parameter Order: parent
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientConnectorServices
Path: v1alpha/{+parent}/clientConnectorServices
Description: Lists ClientConnectorServices in a given project and location.
Parameters:
pageSize
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. Parent value for ListClientConnectorServicesRequest.
Type: string
pageToken
Location: query
Type: string
Description: Optional. A token identifying a page of results the server should return.
filter
Description: Optional. Filtering results.
Type: string
Location: query
orderBy
Type: string
Description: Optional. Hint for how to order the results.
Location: query
▼ ▲ beyondcorp.projects.locations.clientGateways.delete
Parameter Order: name
Parameters:
validateOnly
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location: query
name
Description: Required. Name of the resource
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
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 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).
Type: string
Location: query
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Description: Deletes a single ClientGateway.
▼ ▲ beyondcorp.projects.locations.clientGateways.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways/{clientGatewaysId}
Path: v1alpha/{+name}
Parameter Order: name
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/clientGateways/[^/]+$
Description: Required. Name of the resource
Type: string
Location: path
HTTP Method: GET
Description: Gets details of a single ClientGateway.
▼ ▲ beyondcorp.projects.locations.clientGateways.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
HTTP Method: GET
Parameter Order: parent
Description: Lists ClientGateways in a given project and location.
Parameters:
pageSize
Type: integer
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
filter
Location: query
Type: string
Description: Optional. Filtering results.
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. Parent value for ListClientGatewaysRequest.
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
pageToken
Description: Optional. A token identifying a page of results the server should return.
Type: string
Location: query
Path: v1alpha/{+parent}/clientGateways
▼ ▲ beyondcorp.projects.locations.clientGateways.create
Path: v1alpha/{+parent}/clientGateways
Parameters:
validateOnly
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location: query
Type: boolean
clientGatewayId
Location: query
Description: Optional. User-settable client gateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.
Type: string
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 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).
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. Value for parent.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/clientGateways
Description: Creates a new ClientGateway in a given project and location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST