2024-01-15
▼ ▲ bigqueryconnection.projects.locations.connections.create
Path: v1/{+parent}/connections
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections
HTTP Method: POST
Parameters:
parent
Description: Required. Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
connectionId
Description: Optional. Connection id that should be assigned to the created connection.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Creates a new connection.
▼ ▲ bigqueryconnection.projects.locations.connections.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Returns specified connection.
▼ ▲ bigqueryconnection.projects.locations.connections.list
Path: v1/{+parent}/connections
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections
HTTP Method: GET
Parameters:
parent
Description: Required. Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Required. Page size.
Location: query
Type: integer
Format: int32
pageToken
Description: Page token.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Returns a list of connections in the given project.
▼ ▲ bigqueryconnection.projects.locations.connections.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
HTTP Method: PATCH
Parameters:
name
Description: Required. Name of the connection to update, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Update mask for the connection fields to be updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes:
Description: Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.
▼ ▲ bigqueryconnection.projects.locations.connections.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Deletes connection and associated credential.
▼ ▲ bigqueryconnection.projects.locations.connections.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:getIamPolicy
HTTP Method: POST
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/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes:
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ bigqueryconnection.projects.locations.connections.setIamPolicy
Path: v1/{+resource}:setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}: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/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes:
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ bigqueryconnection.projects.locations.connections.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/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.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes:
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.