Namespace Google.Apis.Connectors.v1.Data
Classes
AuditConfig
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.
AuditLogConfig
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
AuthConfig defines details of a authentication type.
AuthConfigTemplate
AuthConfigTemplate defines required field over an authentication type.
AuthField
AuthField defines a field in an authentication type.
AuthObject
AuthObject defines a JSON schema of an authentication type.
AuthProperty
AuthProperty defines a property of an authentication type.
AuthSchema
AuthSchema defines the schema of an authentication type.
AuthorizationCodeLink
This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.
BillingConfig
Billing config for the connection.
Binding
Associates members
, or principals, with a role
.
CancelOperationRequest
The request message for Operations.CancelOperation.
ConfigVariable
ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
ConfigVariableTemplate
ConfigVariableTemplate provides metadata about a ConfigVariable
that is used in a Connection.
Connection
Connection represents an instance of connector.
ConnectionSchemaMetadata
ConnectionSchemaMetadata is the singleton resource of each connection. It includes the entity and action names of runtime resources exposed by a connection backend.
ConnectionStatus
ConnectionStatus indicates the state of the 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
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
ConnectorsLogConfig
Log configuration for the connection.
CustomConnector
CustomConnector represents the custom connector defined by the customer as part of byoc.
CustomConnectorVersion
CustomConnectorVersion indicates a specific version of a connector.
DailyCycle
Time window specified for daily operations.
Date
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
DeadLetterConfig
Dead Letter configuration details provided by the user.
DenyMaintenancePeriod
DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.
DeprecateCustomConnectorVersionRequest
Request message for ConnectorsService.DeprecateCustomConnectorVersion
Destination
DestinationConfig
Define the Connectors target endpoint.
DestinationConfigTemplate
DestinationConfigTemplate defines required destinations supported by the Connector.
EgressControlConfig
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.
Empty
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); }
EncryptionConfig
Regional encryption config for CMEK details.
EncryptionKey
Encryption Key value.
EndPoint
Endpoint message includes details of the Destination endpoint.
EndpointAttachment
represents the Connector's Endpoint Attachment resource
EnumOption
EnumOption definition
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.
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.
EventingStatus
EventingStatus indicates the state of eventing.
Expr
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.
ExtractionRule
Extraction Rule.
ExtractionRules
Extraction Rules to identity the backends from customer provided configuration in Connection resource.
FetchAuthSchemaResponse
Response message for Connectors.GetAuthSchema.
Field
Metadata of an entity field.
FieldComparison
Field that needs to be compared.
HPAConfig
Autoscaling config for connector deployment system metrics.
Header
Header details for a given header to be added to Endpoint.
InputParameter
Metadata of an input parameter.
Instance
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
JMS message denotes the source of the event
JsonAuthSchema
JsonAuthSchema defines the JSON schema of all authentication types.
JsonSchema
JsonSchema representation of schema metadata
JwtClaims
JWT claims used for the jwt-bearer authorization grant.
ListActionsResponse
Response message for ListActions API
ListConnectionsResponse
Response message for ConnectorsService.ListConnections
ListConnectorVersionsResponse
Response message for Connectors.ListConnectorVersions.
ListConnectorsResponse
Response message for Connectors.ListConnectors.
ListCustomConnectorVersionsResponse
Response message for Connectors.ListCustomConnectorVersions.
ListCustomConnectorsResponse
Response message for Connectors.ListCustomConnectors.
ListEndpointAttachmentsResponse
Response message for ConnectorsService.ListEndpointAttachments
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.
ListenEventRequest
Expected request for ListenEvent API.
ListenEventResponse
Expected response for ListenEvent API.
Location
A resource that represents a Google Cloud location.
LockConfig
Determines whether or no a connection is locked. If locked, a reason must be specified.
LogicalExpression
Struct for representing boolean expressions.
MaintenancePolicy
Defines policies to service maintenance events.
MaintenanceSchedule
Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule
MaintenanceSettings
Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.
MaintenanceWindow
MaintenanceWindow definition.
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.
NodeConfig
Node configuration for the connection.
NodeSloMetadata
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.
NotificationParameter
Contains notification related data.
Oauth2AuthCodeFlow
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.
Oauth2AuthCodeFlowGoogleManaged
Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details.
Oauth2ClientCredentials
Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
Oauth2JwtBearer
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.
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationMetadata
Represents the metadata of the long-running operation.
PerSliSloEligibility
PerSliSloEligibility is a mapping from an SLI name to eligibility.
Policy
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
Provider indicates the owner who provides the connectors.
ProvisionedResource
Describes provisioned dataplane resources.
RefreshConnectionSchemaMetadataRequest
Request message for ConnectorsService.RefreshConnectionSchemaMetadata.
RegionalSettings
Regional Settings details.
RepairEventingRequest
Request message for ConnectorsService.RepairEventing
Resource
Resource definition
ResourceLimits
Resource limits defined for connection pods of a given connector type.
ResourceRequests
Resource requests defined for connection pods of a given connector type.
ResultMetadata
Metadata of result field.
RetryEventSubscriptionRequest
Request message for ConnectorsService.RefreshEventSubscription
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. 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.
RuntimeActionSchema
Schema of a runtime action.
RuntimeConfig
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.
RuntimeEntitySchema
Schema of a runtime entity.
Schedule
Configure the schedule.
SchemaRefreshConfig
Config for connection schema refresh
SearchConnectionInstance
SearchConnectionInstance represents an instance of connector with specific fields
SearchConnectionsResponse
Response message for Connectors.SearchConnections.
Secret
Secret provides a reference to entries in Secret Manager.
SetIamPolicyRequest
Request message for SetIamPolicy
method.
Settings
Global Settings details.
SloEligibility
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
SloMetadata contains resources required for proper SLO classification of the instance.
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
StandardAction
Standard action
StandardEntity
Standard entity
Status
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.
SupportedRuntimeFeatures
Supported runtime features of a connector version.
TestIamPermissionsRequest
Request message for TestIamPermissions
method.
TestIamPermissionsResponse
Response message for TestIamPermissions
method.
TimeOfDay
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
.
UpdatePolicy
Maintenance policy applicable to instance updates.
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.
WeeklyCycle
Time window specified for weekly operations.