Connectors API (connectors:v1)

Additions

Methods


• ▼ ▲ connectors.projects.locations.connections.connectionSchemaMetadata.listEntityTypes

  Path: v1/{+name}:listEntityTypes

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata:listEntityTypes

  HTTP Method: GET

  Parameters:

  name

  Description: Required. Resource name format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

  Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Page size. If unspecified, at most 50 entity types will be returned.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Page token.

  Location: query

  Type: string

  filter

  Description: Required. Filter Wildcards are not supported in the filter currently.

  Location: query

  Type: string

  view

  Description: Specifies which fields are returned in response. Defaults to BASIC view.

  Location: query

  Type: string

  Enum Descriptions:

  Enum:

  • VIEW_UNSPECIFIED
  • BASIC

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: List entity types.

• ▼ ▲ connectors.projects.locations.connections.connectionSchemaMetadata.listActions

  Path: v1/{+name}:listActions

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata:listActions

  HTTP Method: GET

  Parameters:

  name

  Description: Required. Resource name format. projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

  Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Page size. If unspecified, at most 50 actions will be returned.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Page token.

  Location: query

  Type: string

  filter

  Description: Required. Filter Wildcards are not supported in the filter currently.

  Location: query

  Type: string

  view

  Description: Specifies which fields are returned in response. Defaults to BASIC view.

  Location: query

  Type: string

  Enum Descriptions:

  Enum:

  • VIEW_UNSPECIFIED
  • BASIC

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: List actions.

• ▼ ▲ connectors.projects.locations.connections.connectionSchemaMetadata.getEntityType

  Path: v1/{+name}:getEntityType

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata:getEntityType

  HTTP Method: GET

  Parameters:

  name

  Description: Required. Resource name format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

  Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$

  Location: path

  Required: Yes

  Type: string

  entityId

  Description: Required. Id of the entity type.

  Location: query

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Get entity type.

• ▼ ▲ connectors.projects.locations.connections.connectionSchemaMetadata.getAction

  Path: v1/{+name}:getAction

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata:getAction

  HTTP Method: GET

  Parameters:

  name

  Description: Required. Resource name format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata

  Pattern: ^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$

  Location: path

  Required: Yes

  Type: string

  actionId

  Description: Required. Id of the action.

  Location: query

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Get action.

• ▼ ▲ connectors.projects.locations.global.customConnectors.delete

  Path: v1/{+name}

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}

  HTTP Method: DELETE

  Parameters:

  name

  Description: Required. Resource name of the form: `projects/{project}/locations/{location}/customConnectors/{connector}`

  Pattern: ^projects/[^/]+/locations/global/customConnectors/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Deletes a single CustomConnector.

• ▼ ▲ connectors.projects.locations.global.customConnectors.list

  Path: v1/{+parent}/customConnectors

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors

  HTTP Method: GET

  Parameters:

  parent

  Description: Required. Parent resource of the custom connectors, of the form: `projects/*/locations/*` Only global location is supported for CustomConnector resource.

  Pattern: ^projects/[^/]+/locations/global$

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Page size.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Page token.

  Location: query

  Type: string

  filter

  Description: Filter string.

  Location: query

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: List CustomConnectorVersions in a given project

• ▼ ▲ connectors.projects.locations.global.customConnectors.get

  Path: v1/{+name}

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. Resource name of the form: `projects/*/locations/*/customConnectors/*`

  Pattern: ^projects/[^/]+/locations/global/customConnectors/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Gets details of a single CustomConnector.

• ▼ ▲ connectors.projects.locations.global.customConnectors.create

  Path: v1/{+parent}/customConnectors

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors

  HTTP Method: POST

  Parameters:

  parent

  Description: Required. Parent resource of the CreateCustomConnector, of the form: `projects/{project}/locations/*`

  Pattern: ^projects/[^/]+/locations/global$

  Location: path

  Required: Yes

  Type: string

  customConnectorId

  Description: Required. Identifier to assign to the CreateCustomConnector. Must be unique within scope of the parent resource.

  Location: query

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Creates a new CustomConnector in a given project and location.

• ▼ ▲ connectors.projects.locations.global.customConnectors.patch

  Path: v1/{+name}

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}

  HTTP Method: PATCH

  Parameters:

  name

  Description: Identifier. Resource name of the CustomConnector. Format: projects/{project}/locations/{location}/customConnectors/{connector}

  Pattern: ^projects/[^/]+/locations/global/customConnectors/[^/]+$

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Required. Field mask is used to specify the fields to be overwritten in the Connector 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. Set the mask as "*" for full replacement, which means all fields will be overwritten.

  Location: query

  Type: string

  Format: google-fieldmask

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Updates the parameters of a CustomConnector.

• ▼ ▲ connectors.projects.locations.global.customConnectors.customConnectorVersions.list

  Path: v1/{+parent}/customConnectorVersions

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}/customConnectorVersions

  HTTP Method: GET

  Parameters:

  parent

  Description: Required. Parent resource of the connectors, of the form: `projects/*/locations/{location}/customConnectors/*/customConnectorVersions/*`

  Pattern: ^projects/[^/]+/locations/global/customConnectors/[^/]+$

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Page size.

  Location: query

  Type: integer

  Format: int32

  pageToken

  Description: Page token.

  Location: query

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: List CustomConnectorVersions in a given project

• ▼ ▲ connectors.projects.locations.global.customConnectors.customConnectorVersions.get

  Path: v1/{+name}

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}/customConnectorVersions/{customConnectorVersionsId}

  HTTP Method: GET

  Parameters:

  name

  Description: Required. Resource name of the form: `projects/*/locations/{location}/customConnectors/*/customConnectorVersions/*`

  Pattern: ^projects/[^/]+/locations/global/customConnectors/[^/]+/customConnectorVersions/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Gets details of a single CustomConnectorVersion.

• ▼ ▲ connectors.projects.locations.global.customConnectors.customConnectorVersions.create

  Path: v1/{+parent}/customConnectorVersions

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}/customConnectorVersions

  HTTP Method: POST

  Parameters:

  parent

  Description: Required. Parent resource of the CreateCustomConnector, of the form: `projects/{project}/locations/{location}/customConnectors/{custom_connector}`

  Pattern: ^projects/[^/]+/locations/global/customConnectors/[^/]+$

  Location: path

  Required: Yes

  Type: string

  customConnectorVersionId

  Description: Required. Identifier to assign to the CreateCustomConnectorVersion. Must be unique within scope of the parent resource.

  Location: query

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Creates a new CustomConnectorVersion in a given project and location.

• ▼ ▲ connectors.projects.locations.global.customConnectors.customConnectorVersions.patch

  Path: v1/{+name}

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}/customConnectorVersions/{customConnectorVersionsId}

  HTTP Method: PATCH

  Parameters:

  name

  Description: Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}

  Pattern: ^projects/[^/]+/locations/global/customConnectors/[^/]+/customConnectorVersions/[^/]+$

  Location: path

  Required: Yes

  Type: string

  updateMask

  Description: Required. Field mask is used to specify the fields to be overwritten in the Connector 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. Set the mask as "*" for full replacement, which means all fields will be overwritten.

  Location: query

  Type: string

  Format: google-fieldmask

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Updates the parameters of a CustomConnectorVersion.

• ▼ ▲ connectors.projects.locations.global.customConnectors.customConnectorVersions.delete

  Path: v1/{+name}

  Flat Path: v1/projects/{projectsId}/locations/global/customConnectors/{customConnectorsId}/customConnectorVersions/{customConnectorVersionsId}

  HTTP Method: DELETE

  Parameters:

  name

  Description: Required. Resource name of the form: `projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version}`

  Pattern: ^projects/[^/]+/locations/global/customConnectors/[^/]+/customConnectorVersions/[^/]+$

  Location: path

  Required: Yes

  Type: string

  Parameter Order: name

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: Deletes a single CustomConnectorVersion.