connectors/v1 library
Connectors API - v1
Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.
For more information, see cloud.google.com/apigee/docs/api-platform/connectors/about-connectors
Create an instance of ConnectorsApi to access these resources:
- ProjectsResource
- ProjectsLocationsGlobalCustomConnectorsCustomConnectorVersionsResource - ProjectsLocationsGlobalManagedZonesResource
- ProjectsLocationsProvidersConnectorsVersionsEventtypesResource
Classes
- AuditConfig
- Specifies the audit configuration for a service.
- AuthConfig
- AuthConfig defines details of a authentication type.
- AuthConfigTemplate
- AuthConfigTemplate defines required field over an authentication type.
- AuthorizationCodeLink
- This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.
- Binding
-
Associates
members, or principals, with arole. - ConfigVariable
- ConfigVariable represents a configuration variable present in a Connection.
- ConfigVariableTemplate
-
ConfigVariableTemplate provides metadata about a
ConfigVariablethat is used in a Connection. - Connection
- Connection represents an instance of connector.
- ConnectionSchemaMetadata
- ConnectionSchemaMetadata is the singleton resource of each connection.
- Connector
- Connectors indicates a specific connector type, e.x. Salesforce, SAP etc.
- ConnectorInfraConfig
- This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version
- ConnectorsApi
- Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.
- ConnectorVersion
- ConnectorVersion indicates a specific version of a connector.
- ConnectorVersionInfraConfig
- This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version
- CustomConnector
- CustomConnector represents the custom connector defined by the customer as part of byoc.
- CustomConnectorVersion
- CustomConnectorVersion indicates a specific version of a connector.
- DestinationConfig
- Define the Connectors target endpoint.
- DestinationConfigTemplate
- DestinationConfigTemplate defines required destinations supported by the Connector.
- EgressControlConfig
- Egress control config for connector runtime.
- EncryptionConfig
- Regional encryption config for CMEK details.
- EndPoint
- Endpoint message includes details of the Destination endpoint.
- EndpointAttachment
- represents the Connector's Endpoint Attachment resource
- EnumOption
- EnumOption definition
- EventingConfig
- Eventing Configuration of a connection
- EventingConfigTemplate
- Eventing Config details of a connector version.
- EventingDetails
- Eventing Details message.
- EventingRuntimeData
- Eventing runtime data has the details related to eventing managed by the system.
- EventSubscription
- represents the Connector's EventSubscription resource
- EventSubscriptionDestination
- Message for EventSubscription Destination to act on receiving an event
- EventSubscriptionStatus
- EventSubscription Status denotes the status of the EventSubscription resource.
- EventType
- EventType includes fields.
- ExtractionRule
- Extraction Rule.
- ExtractionRules
- Extraction Rules to identity the backends from customer provided configuration in Connection resource.
- Field
- Metadata of an entity field.
- FieldComparison
- Field that needs to be compared.
- Header
- Header details for a given header to be added to Endpoint.
- InputParameter
- Metadata of an input parameter.
- JMS
- JMS message denotes the source of the event
- JsonSchema
- JsonSchema representation of schema metadata
- ListActionsResponse
- Response message for ListActions API
- ListConnectionsResponse
- Response message for ConnectorsService.ListConnections
- ListConnectorsResponse
- Response message for Connectors.ListConnectors.
- ListConnectorVersionsResponse
- Response message for Connectors.ListConnectorVersions.
- ListCustomConnectorsResponse
- Response message for Connectors.ListCustomConnectors.
- ListCustomConnectorVersionsResponse
- Response message for Connectors.ListCustomConnectorVersions.
- ListEndpointAttachmentsResponse
- Response message for ConnectorsService.ListEndpointAttachments
- ListenEventRequest
- Expected request for ListenEvent API.
- ListEntityTypesResponse
- Response message for ListEntityTypes API
- ListEventSubscriptionsResponse
- Response message for ConnectorsService.ListEventSubscriptions
- ListEventTypesResponse
- Response message for Connectors.ListEventTypes.
- ListLocationsResponse
- The response message for Locations.ListLocations.
- ListManagedZonesResponse
- Response message for ConnectorsService.ListManagedZones
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListProvidersResponse
- Response message for Connectors.ListProviders.
- ListRuntimeActionSchemasResponse
- Response message for ConnectorsService.ListRuntimeActionSchemas.
- ListRuntimeEntitySchemasResponse
- Response message for ConnectorsService.ListRuntimeEntitySchemas.
- LogicalExpression
- Struct for representing boolean expressions.
- ManagedZone
- represents the Connector's Managed Zone resource
- MultipleSelectConfig
- MultipleSelectConfig represents the multiple options for a config variable.
- MultipleSelectOption
- MultiplSelecteOption represents the single option for a config variable.
- NetworkConfig
- Regional Network Config.
- Oauth2AuthCodeFlow
- Parameters to support Oauth 2.0 Auth Code Grant Authentication.
- Oauth2ClientCredentials
- Parameters to support Oauth 2.0 Client Credentials Grant Authentication.
- Oauth2JwtBearer
- Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication.
- Operation
- This resource represents a long-running operation that is the result of a network API call.
- Policy
- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
- ProjectsLocationsConnectionsConnectionSchemaMetadataResource
- ProjectsLocationsConnectionsEventSubscriptionsResource
- ProjectsLocationsConnectionsResource
- ProjectsLocationsConnectionsRuntimeActionSchemasResource
- ProjectsLocationsConnectionsRuntimeEntitySchemasResource
- ProjectsLocationsCustomConnectorsCustomConnectorVersionsResource
- ProjectsLocationsCustomConnectorsResource
- ProjectsLocationsEndpointAttachmentsResource
- ProjectsLocationsGlobalCustomConnectorsCustomConnectorVersionsResource
- ProjectsLocationsGlobalCustomConnectorsResource
- ProjectsLocationsGlobalManagedZonesResource
- ProjectsLocationsGlobalResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsProvidersConnectorsResource
- ProjectsLocationsProvidersConnectorsVersionsEventtypesResource
- ProjectsLocationsProvidersConnectorsVersionsResource
- ProjectsLocationsProvidersResource
- ProjectsLocationsResource
- ProjectsResource
- Provider
- Provider indicates the owner who provides the connectors.
- RegionalSettings
- Regional Settings details.
- Resource
- Resource definition
- ResultMetadata
- Metadata of result field.
- RoleGrant
- This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal like service account.
- RuntimeActionSchema
- Schema of a runtime action.
- RuntimeConfig
- RuntimeConfig is the singleton resource of each location.
- RuntimeEntitySchema
- Schema of a runtime entity.
- SchemaRefreshConfig
- Config for connection schema refresh
- SearchConnectionInstance
- SearchConnectionInstance represents an instance of connector with specific fields
- SearchConnectionsResponse
- Response message for Connectors.SearchConnections.
- SetIamPolicyRequest
-
Request message for
SetIamPolicymethod. - Settings
- Global Settings details.
- Source
- Source to extract the backend from.
- SshPublicKey
- Parameters to support Ssh public key Authentication.
- SslConfig
- SSL Configuration of a connection
- SslConfigTemplate
- Ssl config details of a connector version
- SupportedRuntimeFeatures
- Supported runtime features of a connector version.
- UserPassword
- Parameters to support Username and Password Authentication.
- ValidateCustomConnectorSpecRequest
- Request message for ConnectorsService.ValidateCustomConnectorSpec
- ValidateCustomConnectorSpecResponse
- Response message for ConnectorsService.ValidateCustomConnectorSpec
- WebhookData
- WebhookData has details of webhook configuration.
Typedefs
- AuditLogConfig = $AuditLogConfig
- Provides the configuration for logging a type of permissions.
- BillingConfig = $BillingConfig
- Billing config for the connection.
- CancelOperationRequest = $Empty
- The request message for Operations.CancelOperation.
- ConnectionStatus = $ConnectionStatus
- ConnectionStatus indicates the state of the connection.
- ConnectorsLogConfig = $LogConfig
- Log configuration for the connection.
- DeadLetterConfig = $DeadLetterConfig
- Dead Letter configuration details provided by the user.
- DeprecateCustomConnectorVersionRequest = $Empty
- Request message for ConnectorsService.DeprecateCustomConnectorVersion
- Destination = $Destination
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- EncryptionKey = $EncryptionKey
- Encryption Key value.
- EventingStatus = $EventingStatus
- EventingStatus indicates the state of eventing.
- Expr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
- HPAConfig = $HPAConfig
- Autoscaling config for connector deployment system metrics.
- JwtClaims = $JwtClaims
- JWT claims used for the jwt-bearer authorization grant.
- ListenEventResponse = $Empty
- Expected response for ListenEvent API.
- Location = $Location00
- A resource that represents a Google Cloud location.
- LockConfig = $LockConfig
- Determines whether or no a connection is locked.
- NodeConfig = $NodeConfig
- Node configuration for the connection.
- RefreshConnectionSchemaMetadataRequest = $Empty
- Request message for ConnectorsService.RefreshConnectionSchemaMetadata.
- RepairEventingRequest = $Empty
- Request message for ConnectorsService.RepairEventing
- ResourceLimits = $ResourceLimits
- Resource limits defined for connection pods of a given connector type.
- ResourceRequests = $ResourceRequests
- Resource requests defined for connection pods of a given connector type.
- RetryEventSubscriptionRequest = $Empty
- Request message for ConnectorsService.RefreshEventSubscription
- Secret = $Secret
- Secret provides a reference to entries in Secret Manager.
- Status = $Status
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. - TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissionsmethod. - TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissionsmethod.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.