diff --git a/docs/dyn/connectors_v1.projects.locations.connections.eventSubscriptions.html b/docs/dyn/connectors_v1.projects.locations.connections.eventSubscriptions.html new file mode 100644 index 00000000000..9fb7d8bc47d --- /dev/null +++ b/docs/dyn/connectors_v1.projects.locations.connections.eventSubscriptions.html @@ -0,0 +1,421 @@ + + + +

Connectors API . projects . locations . connections . eventSubscriptions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, eventSubscriptionId=None, x__xgafv=None)

+

Creates a new EventSubscription in a given project,location and connection.

+

+ delete(name, x__xgafv=None)

+

Deletes a single EventSubscription.

+

+ get(name, x__xgafv=None)

+

Gets details of a single EventSubscription.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

List EventSubscriptions in a given project,location and connection.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the parameters of a single EventSubscription.

+

+ retry(name, body=None, x__xgafv=None)

+

RetryEventSubscription retries the registration of Subscription.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, eventSubscriptionId=None, x__xgafv=None) + 
Creates a new EventSubscription in a given project,location and connection.
+
+Args:
+  parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # represents the Connector's EventSubscription resource
+  "createTime": "A String", # Output only. Created time.
+  "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
+    "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
+      "endpointUri": "A String", # The URI of the Endpoint.
+      "headers": [ # List of Header to be added to the Endpoint.
+        { # Header details for a given header to be added to Endpoint.
+          "key": "A String", # Key of Header.
+          "value": "A String", # Value of Header.
+        },
+      ],
+    },
+    "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow.
+    "type": "A String", # type of the destination
+  },
+  "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
+  "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
+  "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
+    "description": "A String", # Output only. Description of the state.
+    "state": "A String", # Output only. State of Event Subscription resource.
+  },
+  "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
+  "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
+  "updateTime": "A String", # Output only. Updated time.
+}
+
+  eventSubscriptionId: string, Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a single EventSubscription.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventsubscriptions/*` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets details of a single EventSubscription.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # represents the Connector's EventSubscription resource
+  "createTime": "A String", # Output only. Created time.
+  "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
+    "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
+      "endpointUri": "A String", # The URI of the Endpoint.
+      "headers": [ # List of Header to be added to the Endpoint.
+        { # Header details for a given header to be added to Endpoint.
+          "key": "A String", # Key of Header.
+          "value": "A String", # Value of Header.
+        },
+      ],
+    },
+    "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow.
+    "type": "A String", # type of the destination
+  },
+  "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
+  "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
+  "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
+    "description": "A String", # Output only. Description of the state.
+    "state": "A String", # Output only. State of Event Subscription resource.
+  },
+  "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
+  "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
+  "updateTime": "A String", # Output only. Updated time.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + 
List EventSubscriptions in a given project,location and connection.
+
+Args:
+  parent: string, Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*` (required)
+  filter: string, Filter. https://g3doc.corp.google.com/cloud/control2/g3doc/dev/apihosting/list_filtering.md#filtering.
+  orderBy: string, Order by parameters.
+  pageSize: integer, Page size.
+  pageToken: string, Page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConnectorsService.ListEventSubscriptions
+  "eventSubscriptions": [ # Subscriptions.
+    { # represents the Connector's EventSubscription resource
+      "createTime": "A String", # Output only. Created time.
+      "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
+        "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
+          "endpointUri": "A String", # The URI of the Endpoint.
+          "headers": [ # List of Header to be added to the Endpoint.
+            { # Header details for a given header to be added to Endpoint.
+              "key": "A String", # Key of Header.
+              "value": "A String", # Value of Header.
+            },
+          ],
+        },
+        "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow.
+        "type": "A String", # type of the destination
+      },
+      "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
+      "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
+      "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
+        "description": "A String", # Output only. Description of the state.
+        "state": "A String", # Output only. State of Event Subscription resource.
+      },
+      "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
+      "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
+      "updateTime": "A String", # Output only. Updated time.
+    },
+  ],
+  "nextPageToken": "A String", # Next page token.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates the parameters of a single EventSubscription.
+
+Args:
+  name: string, Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # represents the Connector's EventSubscription resource
+  "createTime": "A String", # Output only. Created time.
+  "destinations": { # Message for EventSubscription Destination to act on receiving an event # Optional. The destination to hit when we receive an event
+    "endpoint": { # Endpoint message includes details of the Destination endpoint. # OPTION 1: Hit an endpoint when we receive an event.
+      "endpointUri": "A String", # The URI of the Endpoint.
+      "headers": [ # List of Header to be added to the Endpoint.
+        { # Header details for a given header to be added to Endpoint.
+          "key": "A String", # Key of Header.
+          "value": "A String", # Value of Header.
+        },
+      ],
+    },
+    "serviceAccount": "A String", # Service account needed for runtime plane to trigger IP workflow.
+    "type": "A String", # type of the destination
+  },
+  "eventTypeId": "A String", # Optional. Event type id of the event of current EventSubscription.
+  "name": "A String", # Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}
+  "status": { # EventSubscription Status denotes the status of the EventSubscription resource. # Optional. Status indicates the status of the event subscription resource
+    "description": "A String", # Output only. Description of the state.
+    "state": "A String", # Output only. State of Event Subscription resource.
+  },
+  "subscriber": "A String", # Optional. name of the Subscriber for the current EventSubscription.
+  "subscriberLink": "A String", # Optional. Link for Subscriber of the current EventSubscription.
+  "updateTime": "A String", # Output only. Updated time.
+}
+
+  updateMask: string, Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ retry(name, body=None, x__xgafv=None) + 
RetryEventSubscription retries the registration of Subscription.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConnectorsService.RefreshEventSubscription
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 3b746bcc48c..9f544584529 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -79,6 +79,11 @@

Instance Methods

Returns the connectionSchemaMetadata Resource.

+

+ eventSubscriptions() +

+

Returns the eventSubscriptions Resource.

+

runtimeActionSchemas()

@@ -116,6 +121,9 @@

Instance Methods

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single Connection.

+

+ repairEventing(name, body=None, x__xgafv=None)

+

RepaiEventing tries to repair eventing related event subscriptions.

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

@@ -220,6 +228,9 @@

Method Details

], "connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User. "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. + "connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. + "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. + }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. @@ -236,6 +247,120 @@

Method Details

}, ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} + "eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection + "additionalVariables": [ # Additional eventing related field values + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "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. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, + "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. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "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. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. + }, + }, + "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + "enrichmentEnabled": True or False, # Enrichment Enabled. + "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto regsitration. + "destinations": [ # The destinations for the key. + { + "host": "A String", # For publicly routable host. + "port": 42, # The port is the target port number that is accepted by the destination. + "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "key": "A String", # The key is the destination identifier that is supported by the Connector. + }, + }, + "eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled. + "eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data. + "eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener. + "status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing. + "description": "A String", # Output only. Description of error if State is set to "ERROR". + "state": "A String", # Output only. State. + }, + }, "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -465,6 +590,9 @@

Method Details

], "connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User. "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. + "connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. + "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. + }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. @@ -481,6 +609,120 @@

Method Details

}, ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} + "eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection + "additionalVariables": [ # Additional eventing related field values + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "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. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, + "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. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "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. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. + }, + }, + "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + "enrichmentEnabled": True or False, # Enrichment Enabled. + "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto regsitration. + "destinations": [ # The destinations for the key. + { + "host": "A String", # For publicly routable host. + "port": 42, # The port is the target port number that is accepted by the destination. + "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "key": "A String", # The key is the destination identifier that is supported by the Connector. + }, + }, + "eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled. + "eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data. + "eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener. + "status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing. + "description": "A String", # Output only. Description of error if State is set to "ERROR". + "state": "A String", # Output only. State. + }, + }, "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -728,6 +970,9 @@

Method Details

], "connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User. "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. + "connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. + "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. + }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. @@ -744,6 +989,120 @@

Method Details

}, ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} + "eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection + "additionalVariables": [ # Additional eventing related field values + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "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. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, + "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. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "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. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. + }, + }, + "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + "enrichmentEnabled": True or False, # Enrichment Enabled. + "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto regsitration. + "destinations": [ # The destinations for the key. + { + "host": "A String", # For publicly routable host. + "port": 42, # The port is the target port number that is accepted by the destination. + "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "key": "A String", # The key is the destination identifier that is supported by the Connector. + }, + }, + "eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled. + "eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data. + "eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener. + "status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing. + "description": "A String", # Output only. Description of error if State is set to "ERROR". + "state": "A String", # Output only. State. + }, + }, "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -919,6 +1278,9 @@

Method Details

], "connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User. "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. + "connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. + "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. + }, "connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. "createTime": "A String", # Output only. Created time. "description": "A String", # Optional. Description of the resource. @@ -935,6 +1297,120 @@

Method Details

}, ], "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} + "eventingConfig": { # Eventing Configuration of a connection # Optional. Eventing config of a connection + "additionalVariables": [ # Additional eventing related field values + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authConfig": { # AuthConfig defines details of a authentication type. # Auth details for the webhook adapter. + "additionalVariables": [ # List containing additional auth configs. + { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + ], + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "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. # Oauth2AuthCodeFlow. + "authCode": "A String", # Authorization code to be exchanged for access and refresh tokens. + "authUri": "A String", # Auth URL for Authorization Code Flow + "clientId": "A String", # Client ID for user-provided OAuth app. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow. + "pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange. + "redirectUri": "A String", # Redirect URI to be provided during the auth code exchange. + "scopes": [ # Scopes the connection will request when the user performs the auth code flow. + "A String", + ], + }, + "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. # Oauth2ClientCredentials. + "clientId": "A String", # The client identifier. + "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + }, + "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. # Oauth2JwtBearer. + "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token. + "audience": "A String", # Value for the "aud" claim. + "issuer": "A String", # Value for the "iss" claim. + "subject": "A String", # Value for the "sub" claim. + }, + }, + "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key. + "certType": "A String", # Format of SSH Client cert. + "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # The user account used to authenticate. + }, + "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword. + "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "username": "A String", # Username. + }, + }, + "encryptionKey": { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. # Encryption key (can be either Google managed or CMEK). + "boolValue": True or False, # Value is a bool. + "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key. + "kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed. + "type": "A String", # Type. + }, + "intValue": "A String", # Value is an integer + "key": "A String", # Key of the config variable. + "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret. + "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`. + }, + "stringValue": "A String", # Value is a string. + }, + "enrichmentEnabled": True or False, # Enrichment Enabled. + "registrationDestinationConfig": { # Define the Connectors target endpoint. # Registration endpoint for auto regsitration. + "destinations": [ # The destinations for the key. + { + "host": "A String", # For publicly routable host. + "port": 42, # The port is the target port number that is accepted by the destination. + "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "key": "A String", # The key is the destination identifier that is supported by the Connector. + }, + }, + "eventingEnablementType": "A String", # Optional. Eventing enablement type. Will be nil if eventing is not enabled. + "eventingRuntimeData": { # Eventing runtime data has the details related to eventing managed by the system. # Output only. Eventing Runtime Data. + "eventsListenerEndpoint": "A String", # Output only. Events listener endpoint. The value will populated after provisioning the events listener. + "status": { # EventingStatus indicates the state of eventing. # Output only. Current status of eventing. + "description": "A String", # Output only. Description of error if State is set to "ERROR". + "state": "A String", # Output only. State. + }, + }, "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -1027,6 +1503,47 @@

Method Details

} +
+ repairEventing(name, body=None, x__xgafv=None) + 
RepaiEventing tries to repair eventing related event subscriptions.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/connections/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConnectorsService.RepairEventing
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None) 
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
diff --git a/docs/dyn/connectors_v1.projects.locations.global_.html b/docs/dyn/connectors_v1.projects.locations.global_.html
index 738fb37d38f..8875a8efe78 100644
--- a/docs/dyn/connectors_v1.projects.locations.global_.html
+++ b/docs/dyn/connectors_v1.projects.locations.global_.html
@@ -85,6 +85,9 @@ 
Instance Methods

 

   getSettings(name, x__xgafv=None)

 
GetGlobalSettings gets settings of a project. GlobalSettings is a singleton resource.

+

+  updateSettings(name, body=None, updateMask=None, x__xgafv=None)

+
Update the global settings of a project.

 
Method Details

 

     close()
@@ -113,4 +116,50 @@ 
Method Details

 }
+
+ updateSettings(name, body=None, updateMask=None, x__xgafv=None) + 
Update the global settings of a project.
+
+Args:
+  name: string, Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Global Settings details.
+  "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings}
+  "payg": True or False, # Output only. Flag indicates if user is in PayG model
+  "tenantProjectId": "A String", # Output only. Tenant project id of the consumer project.
+  "vpcsc": True or False, # Optional. Flag indicates whether vpc-sc is enabled.
+}
+
+  updateMask: string, Required. The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # 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](https://github.com/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](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.html index 8a3f95685b5..286b5447e55 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.html @@ -116,6 +116,17 @@

Method Details

"description": "A String", # Output only. Description of the resource. "displayName": "A String", # Output only. Display name. "documentationUri": "A String", # Output only. Link to documentation page. + "eventingDetails": { # Eventing Details message. # Output only. Eventing details. Will be null if eventing is not supported. + "customEventTypes": True or False, # Output only. Custom Event Types. + "description": "A String", # Output only. Description. + "documentationLink": "A String", # Output only. Link to public documentation. + "iconLocation": "A String", # Output only. Cloud storage location of the icon. + "launchStage": "A String", # Output only. Eventing Launch Stage. + "name": "A String", # Output only. Name of the Eventing trigger. + "searchTags": [ # Output only. Array of search keywords. + "A String", + ], + }, "externalUri": "A String", # Output only. Link to external page. "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", @@ -151,6 +162,17 @@

Method Details

"description": "A String", # Output only. Description of the resource. "displayName": "A String", # Output only. Display name. "documentationUri": "A String", # Output only. Link to documentation page. + "eventingDetails": { # Eventing Details message. # Output only. Eventing details. Will be null if eventing is not supported. + "customEventTypes": True or False, # Output only. Custom Event Types. + "description": "A String", # Output only. Description. + "documentationLink": "A String", # Output only. Link to public documentation. + "iconLocation": "A String", # Output only. Cloud storage location of the icon. + "launchStage": "A String", # Output only. Eventing Launch Stage. + "name": "A String", # Output only. Name of the Eventing trigger. + "searchTags": [ # Output only. Array of search keywords. + "A String", + ], + }, "externalUri": "A String", # Output only. Link to external page. "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.eventtypes.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.eventtypes.html new file mode 100644 index 00000000000..88b5674427d --- /dev/null +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.eventtypes.html @@ -0,0 +1,168 @@ + + + +

Connectors API . projects . locations . providers . connectors . versions . eventtypes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets details of a single event type.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Event Types in a given Connector Version.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Gets details of a single event type.
+
+Args:
+  name: string, Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*/eventtypes/*` Only global location is supported for EventType resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EventType includes fields.
+  "createTime": "A String", # Output only. Created time.
+  "enrichedEventPayloadSchema": "A String", # Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.
+  "entityType": "A String", # Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.
+  "eventPayloadSchema": "A String", # Output only. Schema of webhook event payload.
+  "eventTypeId": "A String", # Output only. Event type id. Example: `ticket.created`.
+  "idPath": "A String", # Output only. Id path denotes the path of id in webhook payload.
+  "name": "A String", # Output only. Resource name of the eventtype. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}/eventtypes/{eventtype} Only global location is supported for Connector resource.
+  "updateTime": "A String", # Output only. Updated time.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists Event Types in a given Connector Version.
+
+Args:
+  parent: string, Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` Only global location is supported for EventType resource. (required)
+  pageSize: integer, Page size.
+  pageToken: string, Page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for Connectors.ListEventTypes.
+  "eventTypes": [ # A list of connector versions.
+    { # EventType includes fields.
+      "createTime": "A String", # Output only. Created time.
+      "enrichedEventPayloadSchema": "A String", # Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.
+      "entityType": "A String", # Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.
+      "eventPayloadSchema": "A String", # Output only. Schema of webhook event payload.
+      "eventTypeId": "A String", # Output only. Event type id. Example: `ticket.created`.
+      "idPath": "A String", # Output only. Id path denotes the path of id in webhook payload.
+      "name": "A String", # Output only. Resource name of the eventtype. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}/eventtypes/{eventtype} Only global location is supported for Connector resource.
+      "updateTime": "A String", # Output only. Updated time.
+    },
+  ],
+  "nextPageToken": "A String", # Next page token.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html index ef012166d30..fbdbcc4ff33 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -74,6 +74,11 @@

Connectors API . projects . locations . providers . connectors . versions

Instance Methods

+

+ eventtypes() +

+

Returns the eventtypes Resource.

+

close()

Close httplib2 connections.

@@ -224,6 +229,9 @@

Method Details

"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. }, ], + "connectorInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector. + "ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests. + }, "createTime": "A String", # Output only. Created time. "destinationConfigTemplates": [ # Output only. List of destination configs needed to create a connection. { # DestinationConfigTemplate defines required destinations supported by the Connector. @@ -253,6 +261,185 @@

Method Details

], }, }, + "eventingConfigTemplate": { # Eventing Config details of a connector version. # Output only. Eventing configuration supported by the Connector. + "additionalVariables": [ # Additional fields that need to be rendered. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP 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. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "authConfigTemplates": [ # AuthConfigTemplates represents the auth values for the webhook adapter. + { # AuthConfigTemplate defines required field over an authentication type. + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP 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. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "description": "A String", # Connector specific description for an authentication template. + "displayName": "A String", # Display name for authentication template. + }, + ], + "autoRefresh": True or False, # Auto refresh to extend webhook life. + "autoRegistrationSupported": True or False, # Auto Registration supported. + "encryptionKeyTemplate": { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. # Encryption key (can be either Google managed or CMEK). + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP 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. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + "enrichmentSupported": True or False, # Enrichment Supported. + "isEventingSupported": True or False, # Is Eventing Supported. + "registrationDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Registration host destination config template. + "defaultPort": 42, # The default port. + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "isAdvanced": True or False, # Whether the current destination tempalate is part of Advanced settings + "key": "A String", # Key of the destination. + "max": 42, # The maximum number of destinations supported for this key. + "min": 42, # The minimum number of destinations supported for this key. + "portFieldType": "A String", # Whether port number should be provided by customers. + "regexPattern": "A String", # Regex pattern for host. + }, + }, "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, @@ -490,6 +677,9 @@

Method Details

"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. }, ], + "connectorInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector. + "ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests. + }, "createTime": "A String", # Output only. Created time. "destinationConfigTemplates": [ # Output only. List of destination configs needed to create a connection. { # DestinationConfigTemplate defines required destinations supported by the Connector. @@ -519,6 +709,185 @@

Method Details

], }, }, + "eventingConfigTemplate": { # Eventing Config details of a connector version. # Output only. Eventing configuration supported by the Connector. + "additionalVariables": [ # Additional fields that need to be rendered. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP 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. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "authConfigTemplates": [ # AuthConfigTemplates represents the auth values for the webhook adapter. + { # AuthConfigTemplate defines required field over an authentication type. + "authKey": "A String", # Identifier key for auth config + "authType": "A String", # The type of authentication configured. + "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. + { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP 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. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + ], + "description": "A String", # Connector specific description for an authentication template. + "displayName": "A String", # Display name for authentication template. + }, + ], + "autoRefresh": True or False, # Auto refresh to extend webhook life. + "autoRegistrationSupported": True or False, # Auto Registration supported. + "encryptionKeyTemplate": { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. # Encryption key (can be either Google managed or CMEK). + "authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE` + "clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source. + "enablePkce": True or False, # Whether to enable PKCE for the auth code flow. + "scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source. + "A String", + ], + "uri": "A String", # The base URI the user must click to trigger the authorization code login flow. + }, + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM` + { # EnumOption definition + "displayName": "A String", # Display name of the option. + "id": "A String", # Id of the option. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP 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. # Role grant configuration for the config variable. + "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. + "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. + "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. + "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. + "type": "A String", # Different types of resource supported. + }, + "roles": [ # List of roles that need to be granted. + "A String", + ], + }, + "state": "A String", # State of the config variable. + "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. + "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. + }, + "enrichmentSupported": True or False, # Enrichment Supported. + "isEventingSupported": True or False, # Is Eventing Supported. + "registrationDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Registration host destination config template. + "defaultPort": 42, # The default port. + "description": "A String", # Description. + "displayName": "A String", # Display name of the parameter. + "isAdvanced": True or False, # Whether the current destination tempalate is part of Advanced settings + "key": "A String", # Key of the destination. + "max": 42, # The maximum number of destinations supported for this key. + "min": 42, # The minimum number of destinations supported for this key. + "portFieldType": "A String", # Whether port number should be provided by customers. + "regexPattern": "A String", # Regex pattern for host. + }, + }, "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index e9d0812122b..866899868d2 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -453,6 +453,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "repairEventing": { + "description": "RepaiEventing tries to repair eventing related event subscriptions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:repairEventing", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.repairEventing", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:repairEventing", + "request": { + "$ref": "RepairEventingRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:setIamPolicy", @@ -543,6 +571,201 @@ } } }, + "eventSubscriptions": { + "methods": { + "create": { + "description": "Creates a new EventSubscription in a given project,location and connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.eventSubscriptions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "eventSubscriptionId": { + "description": "Required. Identifier to assign to the Event Subscription. Must be unique within scope of the parent resource.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/eventSubscriptions", + "request": { + "$ref": "EventSubscription" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single EventSubscription.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}", + "httpMethod": "DELETE", + "id": "connectors.projects.locations.connections.eventSubscriptions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*/eventsubscriptions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single EventSubscription.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}", + "httpMethod": "GET", + "id": "connectors.projects.locations.connections.eventSubscriptions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EventSubscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List EventSubscriptions in a given project,location and connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions", + "httpMethod": "GET", + "id": "connectors.projects.locations.connections.eventSubscriptions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter. https://g3doc.corp.google.com/cloud/control2/g3doc/dev/apihosting/list_filtering.md#filtering.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Order by parameters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the EventSubscription, of the form: `projects/*/locations/*/connections/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/eventSubscriptions", + "response": { + "$ref": "ListEventSubscriptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single EventSubscription.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}", + "httpMethod": "PATCH", + "id": "connectors.projects.locations.connections.eventSubscriptions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update. Fields are specified relative to the Subscription. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the EventSubscription details: * `serviceAccount`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "EventSubscription" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retry": { + "description": "RetryEventSubscription retries the registration of Subscription.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/eventSubscriptions/{eventSubscriptionsId}:retry", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.eventSubscriptions.retry", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/connections/*/eventSubscriptions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/eventSubscriptions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:retry", + "request": { + "$ref": "RetryEventSubscriptionRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "runtimeActionSchemas": { "methods": { "list": { @@ -828,6 +1051,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateSettings": { + "description": "Update the global settings of a project.", + "flatPath": "v1/projects/{projectsId}/locations/global/settings", + "httpMethod": "PATCH", + "id": "connectors.projects.locations.global.updateSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of the Connection. Format: projects/{project}/locations/global/settings}", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/settings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Settings" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1438,6 +1695,73 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "eventtypes": { + "methods": { + "get": { + "description": "Gets details of a single event type.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}/eventtypes/{eventtypesId}", + "httpMethod": "GET", + "id": "connectors.projects.locations.providers.connectors.versions.eventtypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*/eventtypes/*` Only global location is supported for EventType resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/providers/[^/]+/connectors/[^/]+/versions/[^/]+/eventtypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "EventType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Event Types in a given Connector Version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}/eventtypes", + "httpMethod": "GET", + "id": "connectors.projects.locations.providers.connectors.versions.eventtypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` Only global location is supported for EventType resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/providers/[^/]+/connectors/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/eventtypes", + "response": { + "$ref": "ListEventTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } } } @@ -1449,7 +1773,7 @@ } } }, - "revision": "20230614", + "revision": "20230706", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -1803,6 +2127,11 @@ "description": "Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.", "type": "string" }, + "connectorVersionInfraConfig": { + "$ref": "ConnectorVersionInfraConfig", + "description": "Output only. Infra configs supported by Connector Version.", + "readOnly": true + }, "connectorVersionLaunchStage": { "description": "Output only. Flag to mark the version indicating the launch stage.", "enum": [ @@ -1844,6 +2173,29 @@ "readOnly": true, "type": "string" }, + "eventingConfig": { + "$ref": "EventingConfig", + "description": "Optional. Eventing config of a connection" + }, + "eventingEnablementType": { + "description": "Optional. Eventing enablement type. Will be nil if eventing is not enabled.", + "enum": [ + "EVENTING_ENABLEMENT_TYPE_UNSPECIFIED", + "EVENTING_AND_CONNECTION", + "ONLY_EVENTING" + ], + "enumDescriptions": [ + "Eventing Enablement Type Unspecifeied.", + "Both connection and eventing.", + "Only Eventing." + ], + "type": "string" + }, + "eventingRuntimeData": { + "$ref": "EventingRuntimeData", + "description": "Output only. Eventing Runtime Data.", + "readOnly": true + }, "imageLocation": { "description": "Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}", "readOnly": true, @@ -2038,6 +2390,11 @@ "readOnly": true, "type": "string" }, + "eventingDetails": { + "$ref": "EventingDetails", + "description": "Output only. Eventing details. Will be null if eventing is not supported.", + "readOnly": true + }, "externalUri": { "description": "Output only. Link to external page.", "readOnly": true, @@ -2089,6 +2446,18 @@ }, "type": "object" }, + "ConnectorInfraConfig": { + "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", + "id": "ConnectorInfraConfig", + "properties": { + "ratelimitThreshold": { + "description": "Max QPS supported by the connector version before throttling of requests.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "ConnectorVersion": { "description": "ConnectorVersion indicates a specific version of a connector.", "id": "ConnectorVersion", @@ -2109,6 +2478,11 @@ "readOnly": true, "type": "array" }, + "connectorInfraConfig": { + "$ref": "ConnectorInfraConfig", + "description": "Output only. Infra configs supported by Connector.", + "readOnly": true + }, "createTime": { "description": "Output only. Created time.", "format": "google-datetime", @@ -2133,6 +2507,11 @@ "description": "Output only. Configuration for Egress Control.", "readOnly": true }, + "eventingConfigTemplate": { + "$ref": "EventingConfigTemplate", + "description": "Output only. Eventing configuration supported by the Connector.", + "readOnly": true + }, "labels": { "additionalProperties": { "type": "string" @@ -2202,6 +2581,19 @@ }, "type": "object" }, + "ConnectorVersionInfraConfig": { + "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", + "id": "ConnectorVersionInfraConfig", + "properties": { + "ratelimitThreshold": { + "description": "Output only. Max QPS supported by the connector version before throttling of requests.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ConnectorsLogConfig": { "description": "Log configuration for the connection.", "id": "ConnectorsLogConfig", @@ -2354,6 +2746,24 @@ }, "type": "object" }, + "EndPoint": { + "description": "Endpoint message includes details of the Destination endpoint.", + "id": "EndPoint", + "properties": { + "endpointUri": { + "description": "The URI of the Endpoint.", + "type": "string" + }, + "headers": { + "description": "List of Header to be added to the Endpoint.", + "items": { + "$ref": "Header" + }, + "type": "array" + } + }, + "type": "object" + }, "EndpointAttachment": { "description": "represents the Connector's Endpoint Attachment resource", "id": "EndpointAttachment", @@ -2413,9 +2823,339 @@ }, "type": "object" }, - "Expr": { - "description": "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.", - "id": "Expr", + "EventSubscription": { + "description": "represents the Connector's EventSubscription resource", + "id": "EventSubscription", + "properties": { + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "destinations": { + "$ref": "EventSubscriptionDestination", + "description": "Optional. The destination to hit when we receive an event" + }, + "eventTypeId": { + "description": "Optional. Event type id of the event of current EventSubscription.", + "type": "string" + }, + "name": { + "description": "Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{event_subscription}", + "type": "string" + }, + "status": { + "$ref": "EventSubscriptionStatus", + "description": "Optional. Status indicates the status of the event subscription resource" + }, + "subscriber": { + "description": "Optional. name of the Subscriber for the current EventSubscription.", + "type": "string" + }, + "subscriberLink": { + "description": "Optional. Link for Subscriber of the current EventSubscription.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EventSubscriptionDestination": { + "description": "Message for EventSubscription Destination to act on receiving an event", + "id": "EventSubscriptionDestination", + "properties": { + "endpoint": { + "$ref": "EndPoint", + "description": "OPTION 1: Hit an endpoint when we receive an event." + }, + "serviceAccount": { + "description": "Service account needed for runtime plane to trigger IP workflow.", + "type": "string" + }, + "type": { + "description": "type of the destination", + "enum": [ + "TYPE_UNSPECIFIED", + "ENDPOINT" + ], + "enumDescriptions": [ + "Default state.", + "Endpoint - Hit the value of endpoint when event is received" + ], + "type": "string" + } + }, + "type": "object" + }, + "EventSubscriptionStatus": { + "description": "EventSubscription Status denotes the status of the EventSubscription resource.", + "id": "EventSubscriptionStatus", + "properties": { + "description": { + "description": "Output only. Description of the state.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of Event Subscription resource.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "UPDATING", + "ACTIVE", + "SUSPENDED", + "ERROR" + ], + "enumDescriptions": [ + "Default state.", + "EventSubscription creation is in progress.", + "EventSubscription is in Updating status.", + "EventSubscription is in Active state and is ready to receive events.", + "EventSubscription is currently suspended.", + "EventSubscription is in Error state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EventType": { + "description": "EventType includes fields.", + "id": "EventType", + "properties": { + "createTime": { + "description": "Output only. Created time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "enrichedEventPayloadSchema": { + "description": "Output only. Schema of the event payload after enriched. Will be null if read before send is not supported.", + "readOnly": true, + "type": "string" + }, + "entityType": { + "description": "Output only. Runtime entity type name. Will be null if entity type map is not available. Used for read before send feature.", + "readOnly": true, + "type": "string" + }, + "eventPayloadSchema": { + "description": "Output only. Schema of webhook event payload.", + "readOnly": true, + "type": "string" + }, + "eventTypeId": { + "description": "Output only. Event type id. Example: `ticket.created`.", + "readOnly": true, + "type": "string" + }, + "idPath": { + "description": "Output only. Id path denotes the path of id in webhook payload.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the eventtype. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}/eventtypes/{eventtype} Only global location is supported for Connector resource.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EventingConfig": { + "description": "Eventing Configuration of a connection", + "id": "EventingConfig", + "properties": { + "additionalVariables": { + "description": "Additional eventing related field values", + "items": { + "$ref": "ConfigVariable" + }, + "type": "array" + }, + "authConfig": { + "$ref": "AuthConfig", + "description": "Auth details for the webhook adapter." + }, + "encryptionKey": { + "$ref": "ConfigVariable", + "description": "Encryption key (can be either Google managed or CMEK)." + }, + "enrichmentEnabled": { + "description": "Enrichment Enabled.", + "type": "boolean" + }, + "registrationDestinationConfig": { + "$ref": "DestinationConfig", + "description": "Registration endpoint for auto regsitration." + } + }, + "type": "object" + }, + "EventingConfigTemplate": { + "description": "Eventing Config details of a connector version.", + "id": "EventingConfigTemplate", + "properties": { + "additionalVariables": { + "description": "Additional fields that need to be rendered.", + "items": { + "$ref": "ConfigVariableTemplate" + }, + "type": "array" + }, + "authConfigTemplates": { + "description": "AuthConfigTemplates represents the auth values for the webhook adapter.", + "items": { + "$ref": "AuthConfigTemplate" + }, + "type": "array" + }, + "autoRefresh": { + "description": "Auto refresh to extend webhook life.", + "type": "boolean" + }, + "autoRegistrationSupported": { + "description": "Auto Registration supported.", + "type": "boolean" + }, + "encryptionKeyTemplate": { + "$ref": "ConfigVariableTemplate", + "description": "Encryption key (can be either Google managed or CMEK)." + }, + "enrichmentSupported": { + "description": "Enrichment Supported.", + "type": "boolean" + }, + "isEventingSupported": { + "description": "Is Eventing Supported.", + "type": "boolean" + }, + "registrationDestinationConfig": { + "$ref": "DestinationConfigTemplate", + "description": "Registration host destination config template." + } + }, + "type": "object" + }, + "EventingDetails": { + "description": "Eventing Details message.", + "id": "EventingDetails", + "properties": { + "customEventTypes": { + "description": "Output only. Custom Event Types.", + "readOnly": true, + "type": "boolean" + }, + "description": { + "description": "Output only. Description.", + "readOnly": true, + "type": "string" + }, + "documentationLink": { + "description": "Output only. Link to public documentation.", + "readOnly": true, + "type": "string" + }, + "iconLocation": { + "description": "Output only. Cloud storage location of the icon.", + "readOnly": true, + "type": "string" + }, + "launchStage": { + "description": "Output only. Eventing Launch Stage.", + "enum": [ + "LAUNCH_STAGE_UNSPECIFIED", + "PREVIEW", + "GA", + "DEPRECATED", + "PRIVATE_PREVIEW" + ], + "enumDescriptions": [ + "LAUNCH_STAGE_UNSPECIFIED.", + "PREVIEW.", + "GA.", + "DEPRECATED.", + "PRIVATE_PREVIEW." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Name of the Eventing trigger.", + "readOnly": true, + "type": "string" + }, + "searchTags": { + "description": "Output only. Array of search keywords.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "EventingRuntimeData": { + "description": "Eventing runtime data has the details related to eventing managed by the system.", + "id": "EventingRuntimeData", + "properties": { + "eventsListenerEndpoint": { + "description": "Output only. Events listener endpoint. The value will populated after provisioning the events listener.", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "EventingStatus", + "description": "Output only. Current status of eventing.", + "readOnly": true + } + }, + "type": "object" + }, + "EventingStatus": { + "description": "EventingStatus indicates the state of eventing.", + "id": "EventingStatus", + "properties": { + "description": { + "description": "Output only. Description of error if State is set to \"ERROR\".", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "ERROR" + ], + "enumDescriptions": [ + "Default state.", + "Eventing is enabled and ready to receive events.", + "Eventing is not active due to an error." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "description": "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.", + "id": "Expr", "properties": { "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", @@ -2526,6 +3266,53 @@ "DATA_TYPE_TIME_WITH_TIMEZONE", "DATA_TYPE_TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Data type is not specified.", "DEPRECATED! Use DATA_TYPE_INTEGER.", @@ -2640,6 +3427,21 @@ }, "type": "object" }, + "Header": { + "description": "Header details for a given header to be added to Endpoint.", + "id": "Header", + "properties": { + "key": { + "description": "Key of Header.", + "type": "string" + }, + "value": { + "description": "Value of Header.", + "type": "string" + } + }, + "type": "object" + }, "InputParameter": { "description": "Metadata of an input parameter.", "id": "InputParameter", @@ -2693,6 +3495,53 @@ "DATA_TYPE_TIME_WITH_TIMEZONE", "DATA_TYPE_TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Data type is not specified.", "DEPRECATED! Use DATA_TYPE_INTEGER.", @@ -2880,6 +3729,49 @@ }, "type": "object" }, + "ListEventSubscriptionsResponse": { + "description": "Response message for ConnectorsService.ListEventSubscriptions", + "id": "ListEventSubscriptionsResponse", + "properties": { + "eventSubscriptions": { + "description": "Subscriptions.", + "items": { + "$ref": "EventSubscription" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListEventTypesResponse": { + "description": "Response message for Connectors.ListEventTypes.", + "id": "ListEventTypesResponse", + "properties": { + "eventTypes": { + "description": "A list of connector versions.", + "items": { + "$ref": "EventType" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Next page token.", + "type": "string" + } + }, + "type": "object" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -3407,6 +4299,12 @@ "properties": {}, "type": "object" }, + "RepairEventingRequest": { + "description": "Request message for ConnectorsService.RepairEventing", + "id": "RepairEventingRequest", + "properties": {}, + "type": "object" + }, "Resource": { "description": "Resource definition", "id": "Resource", @@ -3489,6 +4387,53 @@ "DATA_TYPE_TIME_WITH_TIMEZONE", "DATA_TYPE_TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Data type is not specified.", "DEPRECATED! Use DATA_TYPE_INTEGER.", @@ -3549,6 +4494,12 @@ }, "type": "object" }, + "RetryEventSubscriptionRequest": { + "description": "Request message for ConnectorsService.RefreshEventSubscription", + "id": "RetryEventSubscriptionRequest", + "properties": {}, + "type": "object" + }, "RoleGrant": { "description": "This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP 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.", "id": "RoleGrant", @@ -3671,6 +4622,15 @@ "DELETING", "UPDATING" ], + "enumDeprecated": [ + false, + true, + true, + false, + false, + false, + false + ], "enumDescriptions": [ "STATE_UNSPECIFIED.", "INACTIVE.", diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 032b3140e4a..c7b7ebcb0b9 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -478,7 +478,7 @@ } } }, - "revision": "20230614", + "revision": "20230706", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "Action": { @@ -672,6 +672,53 @@ "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", @@ -801,6 +848,53 @@ "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", @@ -1015,6 +1109,53 @@ "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + true, + false, + true, + true, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.",