app_connectors

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

Overview

Name	app_connectors
Type	Resource
Id	google.beyondcorp.app_connectors

Fields

The following fields are returned by SELECT queries:

projects_locations_app_connectors_get

Successful response

Name	Datatype	Description
name	string	Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
displayName	string	Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters.
labels	object	Optional. Resource labels to represent user provided metadata.
principalInfo	object	Required. Principal information about the Identity of the AppConnector. (id: GoogleCloudBeyondcorpAppconnectorsV1AppConnectorPrincipalInfo)
resourceInfo	object	Optional. Resource info of the connector. (id: GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo)
state	string	Output only. The current state of the AppConnector.
uid	string	Output only. A unique identifier for the instance generated by the system.
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.

projects_locations_app_connectors_list

Successful response

Name	Datatype	Description
name	string	Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
displayName	string	Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters.
labels	object	Optional. Resource labels to represent user provided metadata.
principalInfo	object	Required. Principal information about the Identity of the AppConnector. (id: GoogleCloudBeyondcorpAppconnectorsV1AppConnectorPrincipalInfo)
resourceInfo	object	Optional. Resource info of the connector. (id: GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo)
state	string	Output only. The current state of the AppConnector.
uid	string	Output only. A unique identifier for the instance generated by the system.
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_app_connectors_get	select	projectsId, locationsId, appConnectorsId		Gets details of a single AppConnector.
projects_locations_app_connectors_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists AppConnectors in a given project and location.
projects_locations_app_connectors_create	insert	projectsId, locationsId	appConnectorId, requestId, validateOnly	Creates a new AppConnector in a given project and location.
projects_locations_app_connectors_patch	update	projectsId, locationsId, appConnectorsId	updateMask, requestId, validateOnly	Updates the parameters of a single AppConnector.
projects_locations_app_connectors_delete	delete	projectsId, locationsId, appConnectorsId	requestId, validateOnly	Deletes a single AppConnector.
projects_locations_app_connectors_resolve_instance_config	exec	projectsId, locationsId, appConnectorsId		Gets instance configuration for a given AppConnector. An internal method called by a AppConnector to get its container config.
projects_locations_app_connectors_report_status	exec	projectsId, locationsId, appConnectorsId		Report status for a given connector.

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
appConnectorsId	string
locationsId	string
projectsId	string
appConnectorId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_app_connectors_get

Gets details of a single AppConnector.

SELECT
name,
createTime,
displayName,
labels,
principalInfo,
resourceInfo,
state,
uid,
updateTime
FROM google.beyondcorp.app_connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND appConnectorsId = '{{ appConnectorsId }}' -- required;

projects_locations_app_connectors_list

Lists AppConnectors in a given project and location.

SELECT
name,
createTime,
displayName,
labels,
principalInfo,
resourceInfo,
state,
uid,
updateTime
FROM google.beyondcorp.app_connectors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_app_connectors_create

Creates a new AppConnector in a given project and location.

INSERT INTO google.beyondcorp.app_connectors (
data__name,
data__labels,
data__displayName,
data__principalInfo,
data__resourceInfo,
projectsId,
locationsId,
appConnectorId,
requestId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ displayName }}',
'{{ principalInfo }}',
'{{ resourceInfo }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ appConnectorId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: app_connectors
  props:
    - name: projectsId
      value: string
      description: Required parameter for the app_connectors resource.
    - name: locationsId
      value: string
      description: Required parameter for the app_connectors resource.
    - name: name
      value: string
      description: >
        Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector.
        
    - name: labels
      value: object
      description: >
        Optional. Resource labels to represent user provided metadata.
        
    - name: displayName
      value: string
      description: >
        Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters.
        
    - name: principalInfo
      value: object
      description: >
        Required. Principal information about the Identity of the AppConnector.
        
    - name: resourceInfo
      value: object
      description: >
        Optional. Resource info of the connector.
        
    - name: appConnectorId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_app_connectors_patch

Updates the parameters of a single AppConnector.

UPDATE google.beyondcorp.app_connectors
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__displayName = '{{ displayName }}',
data__principalInfo = '{{ principalInfo }}',
data__resourceInfo = '{{ resourceInfo }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appConnectorsId = '{{ appConnectorsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND validateOnly = {{ validateOnly}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_app_connectors_delete

Deletes a single AppConnector.

DELETE FROM google.beyondcorp.app_connectors
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appConnectorsId = '{{ appConnectorsId }}' --required
AND requestId = '{{ requestId }}'
AND validateOnly = '{{ validateOnly }}';

Lifecycle Methods

projects_locations_app_connectors_resolve_instance_config

Gets instance configuration for a given AppConnector. An internal method called by a AppConnector to get its container config.

EXEC google.beyondcorp.app_connectors.projects_locations_app_connectors_resolve_instance_config 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@appConnectorsId='{{ appConnectorsId }}' --required;

projects_locations_app_connectors_report_status

Report status for a given connector.

EXEC google.beyondcorp.app_connectors.projects_locations_app_connectors_report_status 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@appConnectorsId='{{ appConnectorsId }}' --required 
@@json=
'{
"resourceInfo": "{{ resourceInfo }}", 
"requestId": "{{ requestId }}", 
"validateOnly": {{ validateOnly }}
}';