2024-05-24
▼ ▲ developerconnect.projects.locations.list
Path: v1/{+name}/locations
Flat Path: v1/projects/{projectsId}/locations
HTTP Method: GET
Parameters:
name
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
filter
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
Type: string
pageSize
Description: The maximum number of results to return. If not set, the service selects a default.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists information about the supported locations for this service.
▼ ▲ developerconnect.projects.locations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
HTTP Method: GET
Parameters:
name
Description: Resource name for the location.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets information about a location.
▼ ▲ developerconnect.projects.locations.operations.list
Path: v1/{+name}/operations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method: GET
Parameters:
name
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
pageToken
Description: The standard list page token.
Location: query
Type: string
Parameter Order: name
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`.
▼ ▲ developerconnect.projects.locations.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ developerconnect.projects.locations.operations.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: DELETE
Parameters:
name
Description: The name of the operation resource to be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ developerconnect.projects.locations.operations.cancel
Path: v1/{+name}:cancel
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method: POST
Parameters:
name
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ developerconnect.projects.locations.connections.list
Path: v1/{+parent}/connections
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections
HTTP Method: GET
Parameters:
parent
Description: Required. Parent value for ListConnectionsRequest
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Connections in a given project and location.
▼ ▲ developerconnect.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 resource
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single Connection.
▼ ▲ developerconnect.projects.locations.connections.create
Path: v1/{+parent}/connections
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections
HTTP Method: POST
Parameters:
parent
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
connectionId
Description: Required. Id of the requesting object If auto-generating Id server-side, remove this field and connection_id from the method_signature of Create RPC
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 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).
Location: query
Type: string
validateOnly
Description: Optional. If set, validate the request, but do not actually post it.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new Connection in a given project and location.
▼ ▲ developerconnect.projects.locations.connections.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the Connection 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.
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 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).
Location: query
Type: string
allowMissing
Description: Optional. If set to true, and the connection is not found a new connection will be created. In this situation `update_mask` is ignored. The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties).
Location: query
Type: boolean
validateOnly
Description: Optional. If set, validate the request, but do not actually post it.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single Connection.
▼ ▲ developerconnect.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 resource
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
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, validate the request, but do not actually post it.
Location: query
Type: boolean
etag
Description: Optional. The current etag of the Connection. If an etag is provided and does not match the current etag of the Connection, deletion will be blocked and an ABORTED error will be returned.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Connection.
▼ ▲ developerconnect.projects.locations.connections.fetchLinkableGitRepositories
Path: v1/{+connection}:fetchLinkableGitRepositories
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchLinkableGitRepositories
HTTP Method: GET
Parameters:
connection
Description: Required. The name of the Connection. Format: `projects/*/locations/*/connections/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Number of results to return in the list. Defaults to 20.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Page start.
Location: query
Type: string
Parameter Order: connection
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: FetchLinkableGitRepositories returns a list of git repositories from an SCM that are available to be added to a Connection.
▼ ▲ developerconnect.projects.locations.connections.fetchGitHubInstallations
Path: v1/{+connection}:fetchGitHubInstallations
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:fetchGitHubInstallations
HTTP Method: GET
Parameters:
connection
Description: Required. The resource name of the connection in the format `projects/*/locations/*/connections/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: connection
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: FetchGitHubInstallations returns the list of GitHub Installations that are available to be added to a Connection. For github.com, only installations accessible to the authorizer token are returned. For GitHub Enterprise, all installations are returned.
▼ ▲ developerconnect.projects.locations.connections.processGitHubEnterpriseWebhook
Path: v1/{+parent}/connections:processGitHubEnterpriseWebhook
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections:processGitHubEnterpriseWebhook
HTTP Method: POST
Parameters:
parent
Description: Required. Project and location where the webhook will be received. Format: `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: ProcessGitHubEnterpriseWebhook is called by the external GitHub Enterprise instances for notifying events.
▼ ▲ developerconnect.projects.locations.connections.processGitLabEnterpriseWebhook
Path: v1/{+parent}/connections:processGitLabEnterpriseWebhook
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections:processGitLabEnterpriseWebhook
HTTP Method: POST
Parameters:
parent
Description: Required. Project and location where the webhook will be received. Format: `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: ProcessGitLabEnterpriseWebhook is called by the external GitLab Enterprise instances for notifying events.
▼ ▲ developerconnect.projects.locations.connections.processGitLabWebhook
Path: v1/{+parent}/connections:processGitLabWebhook
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections:processGitLabWebhook
HTTP Method: POST
Parameters:
parent
Description: Required. Project and location where the webhook will be received. Format: `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: ProcessGitLabWebhook is called by the GitLab.com for notifying events.
▼ ▲ developerconnect.projects.locations.connections.gitRepositoryLinks.create
Path: v1/{+parent}/gitRepositoryLinks
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks
HTTP Method: POST
Parameters:
parent
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
gitRepositoryLinkId
Description: Required. The ID to use for the repository, which will become the final component of the repository's resource name. This ID should be unique in the connection. Allows alphanumeric characters and any of -._~%!$&'()*+,;=@.
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 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).
Location: query
Type: string
validateOnly
Description: Optional. If set, validate the request, but do not actually post it.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a GitRepositoryLink. Upon linking a Git Repository, Developer Connect will configure the Git Repository to send webhook events to Developer Connect. Connections that use Firebase GitHub Application will have events forwarded to the Firebase service. All other Connections will have events forwarded to Cloud Build.
▼ ▲ developerconnect.projects.locations.connections.gitRepositoryLinks.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$
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, validate the request, but do not actually post it.
Location: query
Type: boolean
etag
Description: Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single GitRepositoryLink.
▼ ▲ developerconnect.projects.locations.connections.gitRepositoryLinks.list
Path: v1/{+parent}/gitRepositoryLinks
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks
HTTP Method: GET
Parameters:
parent
Description: Required. Parent value for ListGitRepositoryLinksRequest
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists GitRepositoryLinks in a given project, location, and connection.
▼ ▲ developerconnect.projects.locations.connections.gitRepositoryLinks.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the resource
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single GitRepositoryLink.
▼ ▲ developerconnect.projects.locations.connections.gitRepositoryLinks.fetchReadWriteToken
Path: v1/{+gitRepositoryLink}:fetchReadWriteToken
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:fetchReadWriteToken
HTTP Method: POST
Parameters:
gitRepositoryLink
Description: Required. The resource name of the gitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: gitRepositoryLink
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Fetches read/write token of a given gitRepositoryLink.
▼ ▲ developerconnect.projects.locations.connections.gitRepositoryLinks.fetchReadToken
Path: v1/{+gitRepositoryLink}:fetchReadToken
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:fetchReadToken
HTTP Method: POST
Parameters:
gitRepositoryLink
Description: Required. The resource name of the gitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: gitRepositoryLink
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Fetches read token of a given gitRepositoryLink.
▼ ▲ developerconnect.projects.locations.connections.gitRepositoryLinks.fetchGitRefs
Path: v1/{+gitRepositoryLink}:fetchGitRefs
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/gitRepositoryLinks/{gitRepositoryLinksId}:fetchGitRefs
HTTP Method: GET
Parameters:
gitRepositoryLink
Description: Required. The resource name of GitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.
Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$
Location: path
Required: Yes
Type: string
refType
Description: Required. Type of refs to fetch.
Location: query
Type: string
Enum Descriptions:
Enum:
pageSize
Description: Optional. Number of results to return in the list. Default to 20.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Page start.
Location: query
Type: string
Parameter Order: gitRepositoryLink
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Fetch the list of branches or tags for a given repository.