account_connectors

Creates, updates, deletes, gets or lists an account_connectors resource.

Overview

Name	account_connectors
Type	Resource
Id	google.developerconnect.account_connectors

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the accountConnector, in the format projects/{project}/locations/{location}/accountConnectors/{account_connector_id}.
annotations	object	Optional. Allows users to store small amounts of arbitrary data.
createTime	string (google-datetime)	Output only. The timestamp when the accountConnector was created.
etag	string	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.
labels	object	Optional. Labels as key value pairs
oauthStartUri	string	Output only. Start OAuth flow by clicking on this URL.
providerOauthConfig	object	Provider OAuth config. (id: ProviderOAuthConfig)
updateTime	string (google-datetime)	Output only. The timestamp when the accountConnector was updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the accountConnector, in the format projects/{project}/locations/{location}/accountConnectors/{account_connector_id}.
annotations	object	Optional. Allows users to store small amounts of arbitrary data.
createTime	string (google-datetime)	Output only. The timestamp when the accountConnector was created.
etag	string	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.
labels	object	Optional. Labels as key value pairs
oauthStartUri	string	Output only. Start OAuth flow by clicking on this URL.
providerOauthConfig	object	Provider OAuth config. (id: ProviderOAuthConfig)
updateTime	string (google-datetime)	Output only. The timestamp when the accountConnector was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, accountConnectorsId		Gets details of a single AccountConnector.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists AccountConnectors in a given project and location.
create	insert	projectsId, locationsId	accountConnectorId, requestId, validateOnly	Creates a new AccountConnector in a given project and location.
patch	update	projectsId, locationsId, accountConnectorsId	updateMask, requestId, allowMissing, validateOnly	Updates the parameters of a single AccountConnector.
delete	delete	projectsId, locationsId, accountConnectorsId	requestId, validateOnly, etag, force	Deletes a single AccountConnector.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountConnectorsId	string
locationsId	string
projectsId	string
accountConnectorId	string
allowMissing	boolean
etag	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Gets details of a single AccountConnector.

SELECT
name,
annotations,
createTime,
etag,
labels,
oauthStartUri,
providerOauthConfig,
updateTime
FROM google.developerconnect.account_connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND accountConnectorsId = '{{ accountConnectorsId }}' -- required;

list

Lists AccountConnectors in a given project and location.

SELECT
name,
annotations,
createTime,
etag,
labels,
oauthStartUri,
providerOauthConfig,
updateTime
FROM google.developerconnect.account_connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new AccountConnector in a given project and location.

INSERT INTO google.developerconnect.account_connectors (
data__providerOauthConfig,
data__name,
data__annotations,
data__etag,
data__labels,
projectsId,
locationsId,
accountConnectorId,
requestId,
validateOnly
)
SELECT 
'{{ providerOauthConfig }}',
'{{ name }}',
'{{ annotations }}',
'{{ etag }}',
'{{ labels }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ accountConnectorId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: account_connectors
  props:
    - name: projectsId
      value: string
      description: Required parameter for the account_connectors resource.
    - name: locationsId
      value: string
      description: Required parameter for the account_connectors resource.
    - name: providerOauthConfig
      value: object
      description: >
        Provider OAuth config.
        
    - name: name
      value: string
      description: >
        Identifier. The resource name of the accountConnector, in the format `projects/{project}/locations/{location}/accountConnectors/{account_connector_id}`.
        
    - name: annotations
      value: object
      description: >
        Optional. Allows users to store small amounts of arbitrary data.
        
    - name: etag
      value: string
      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.
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs
        
    - name: accountConnectorId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Updates the parameters of a single AccountConnector.

UPDATE google.developerconnect.account_connectors
SET 
data__providerOauthConfig = '{{ providerOauthConfig }}',
data__name = '{{ name }}',
data__annotations = '{{ annotations }}',
data__etag = '{{ etag }}',
data__labels = '{{ labels }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND accountConnectorsId = '{{ accountConnectorsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND allowMissing = {{ allowMissing}}
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single AccountConnector.

DELETE FROM google.developerconnect.account_connectors
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND accountConnectorsId = '{{ accountConnectorsId }}' --required
AND requestId = '{{ requestId }}'
AND validateOnly = '{{ validateOnly }}'
AND etag = '{{ etag }}'
AND force = '{{ force }}';