View Source API Reference google_api_connectors v0.11.0

Modules

API client metadata for GoogleApi.Connectors.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Connectors.V1.

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

AuthConfig defines details of a authentication type.

AuthConfigTemplate defines required field over an authentication type.

This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.

Billing config for the connection.

Associates members, or principals, with a role.

The request message for Operations.CancelOperation.

ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.

ConfigVariableTemplate provides metadata about a ConfigVariable that is used in a Connection.

Connection represents an instance of connector.

ConnectionSchemaMetadata is the singleton resource of each connection. It includes the entity and action names of runtime resources exposed by a connection backend.

ConnectionStatus indicates the state of the connection.

Connectors indicates a specific connector type, e.x. Salesforce, SAP etc.

This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version

ConnectorVersion indicates a specific version of a connector.

This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version

Log configuration for the connection.

CustomConnector represents the custom connector defined by the customer as part of byoc.

CustomConnectorVersion indicates a specific version of a connector.

Time window specified for daily operations.

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp

Dead Letter configuration details provided by the user.

DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.

Request message for ConnectorsService.DeprecateCustomConnectorVersion

Attributes

  • host (type: String.t, default: nil) - For publicly routable host.
  • port (type: integer(), default: nil) - The port is the target port number that is accepted by the destination.
  • serviceAttachment (type: String.t, default: nil) - PSC service attachments. Format: projects//regions//serviceAttachments/*

Define the Connectors target endpoint.

DestinationConfigTemplate defines required destinations supported by the Connector.

Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Regional encryption config for CMEK details.

Endpoint message includes details of the Destination endpoint.

represents the Connector's Endpoint Attachment resource

represents the Connector's EventSubscription resource

Message for EventSubscription Destination to act on receiving an event

EventSubscription Status denotes the status of the EventSubscription resource.

EventType includes fields.

Eventing Configuration of a connection

Eventing Config details of a connector version.

Eventing runtime data has the details related to eventing managed by the system.

EventingStatus indicates the state of eventing.

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Extraction Rules to identity the backends from customer provided configuration in Connection resource.

Metadata of an entity field.

Field that needs to be compared.

Autoscaling config for connector deployment system metrics.

Header details for a given header to be added to Endpoint.

Metadata of an input parameter.

Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } LINT.IfChange

JMS message denotes the source of the event

JsonSchema representation of schema metadata

JWT claims used for the jwt-bearer authorization grant.

Response message for ListActions API

Response message for ConnectorsService.ListConnections

Response message for Connectors.ListConnectorVersions.

Response message for Connectors.ListConnectors.

Response message for Connectors.ListCustomConnectorVersions.

Response message for Connectors.ListCustomConnectors.

Response message for ConnectorsService.ListEndpointAttachments

Response message for ListEntityTypes API

Response message for ConnectorsService.ListEventSubscriptions

Response message for Connectors.ListEventTypes.

The response message for Locations.ListLocations.

Response message for ConnectorsService.ListManagedZones

The response message for Operations.ListOperations.

Response message for Connectors.ListProviders.

Response message for ConnectorsService.ListRuntimeActionSchemas.

Response message for ConnectorsService.ListRuntimeEntitySchemas.

Expected request for ListenEvent API.

Expected response for ListenEvent API.

A resource that represents a Google Cloud location.

Determines whether or no a connection is locked. If locked, a reason must be specified.

Struct for representing boolean expressions.

Defines policies to service maintenance events.

Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule

Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.

MaintenanceWindow definition.

represents the Connector's Managed Zone resource

MultipleSelectConfig represents the multiple options for a config variable.

MultiplSelecteOption represents the single option for a config variable.

Node configuration for the connection.

Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.

Contains notification related data.

Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.

Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.

Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.

This resource represents a long-running operation that is the result of a network API call.

Represents the metadata of the long-running operation.

PerSliSloEligibility is a mapping from an SLI name to eligibility.

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.

Provider indicates the owner who provides the connectors.

Describes provisioned dataplane resources.

Request message for ConnectorsService.RefreshConnectionSchemaMetadata.

Request message for ConnectorsService.RepairEventing

Resource limits defined for connection pods of a given connector type.

Resource requests defined for connection pods of a given connector type.

Request message for ConnectorsService.RefreshEventSubscription

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. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user.

RuntimeConfig is the singleton resource of each location. It includes generic resource configs consumed by control plane and runtime plane like: pub/sub topic/subscription resource name, Cloud Storage location storing schema etc.

Configure the schedule.

Config for connection schema refresh

SearchConnectionInstance represents an instance of connector with specific fields

Response message for Connectors.SearchConnections.

Secret provides a reference to entries in Secret Manager.

Request message for SetIamPolicy method.

Global Settings details.

SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.

SloMetadata contains resources required for proper SLO classification of the instance.

Source to extract the backend from.

Parameters to support Ssh public key Authentication.

SSL Configuration of a connection

Ssl config details of a connector version

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Supported runtime features of a connector version.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

Maintenance policy applicable to instance updates.

Parameters to support Username and Password Authentication.

Request message for ConnectorsService.ValidateCustomConnectorSpec

Response message for ConnectorsService.ValidateCustomConnectorSpec

WebhookData has details of webhook configuration.

Time window specified for weekly operations.

API client metadata for GoogleApi.Connectors.V2.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Connectors.V2.

AccessCredentials includes the OAuth access token, and the other fields returned along with it.

Action message contains metadata information about a single action present in the external system.

AuthCodeData contains the data the runtime plane will give the connector backend in exchange for access and refresh tokens.

Response containing status of the connector for readiness prober.

Time window specified for daily operations.

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp

DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

'Entity row'/ 'Entity' refers to a single row of an entity type.

EntityType message contains metadata information about a single entity type present in the external system.

ExchangeAuthCodeRequest currently includes the auth code data.

ExchangeAuthCodeResponse includes the returned access token and its associated credentials.

Request message for ActionService.ExecuteAction

Response message for ActionService.ExecuteAction

An execute sql query request containing the query and the connection to execute it on.

A response returned by the connection after executing the sql query.

Message contains EntityType's Field metadata.

Input Parameter message contains metadata about the parameters required for executing an Action.

Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } LINT.IfChange

JsonSchema representation of schema metadata

Response message for ActionService.ListActions

Response message for EntityService.ListEntities

Response message for EntityService.ListEntityTypes

Defines policies to service maintenance events.

Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule

Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.

MaintenanceWindow definition.

Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.

Contains notification related data.

PerSliSloEligibility is a mapping from an SLI name to eligibility.

Describes provisioned dataplane resources.

A wrapper around the SQL query statement. This is needed so that the JSON representation of ExecuteSqlQueryRequest has the following format: {"query":"select *"}.

Attributes

  • name (type: String.t, default: nil) - Name of the reference field.
  • type (type: String.t, default: nil) - Name of reference entity type.

RefreshAccessTokenRequest includes the refresh token.

RefreshAccessTokenResponse includes the returned access token and its associated credentials.

Result Metadata message contains metadata about the result returned after executing an Action.

Configure the schedule.

SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.

SloMetadata contains resources required for proper SLO classification of the instance.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

Response message for EntityService.UpdateEntitiesWithConditions

Maintenance policy applicable to instance updates.

Time window specified for weekly operations.