{ "description": "Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.", "basePath": "", "discoveryVersion": "v1", "mtlsRootUrl": "https://connectors.mtls.googleapis.com/", "schemas": { "ProvisionedResource": { "description": "Describes provisioned dataplane resources.", "type": "object", "properties": { "resourceUrl": { "description": "URL identifying the resource, e.g. \"https://www.googleapis.com/compute/v1/projects/...)\".", "type": "string" }, "resourceType": { "description": "Type of the resource. This can be either a GCP resource or a custom one (e.g. another cloud provider's VM). For GCP compute resources use singular form of the names listed in GCP compute API documentation (https://cloud.google.com/compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: 'compute-instance', 'compute-disk', 'compute-autoscaler'.", "type": "string" } }, "id": "ProvisionedResource" }, "ListToolsResponse": { "description": "Response message for ConnectorAgentService.ListTools", "type": "object", "id": "ListToolsResponse", "properties": { "tools": { "description": "List of available tools.", "type": "array", "items": { "$ref": "Tool" } }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "nextPageToken": { "description": "Next page token.", "type": "string" } } }, "SloMetadata": { "properties": { "nodes": { "description": "Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch.", "type": "array", "items": { "$ref": "NodeSloMetadata" } }, "perSliEligibility": { "description": "Optional. Multiple per-instance SLI eligibilities which apply for individual SLIs.", "$ref": "PerSliSloEligibility" }, "tier": { "description": "Name of the SLO tier the Instance belongs to. This name will be expected to match the tiers specified in the service SLO configuration. Field is mandatory and must not be empty.", "type": "string" } }, "id": "SloMetadata", "description": "SloMetadata contains resources required for proper SLO classification of the instance.", "type": "object" }, "ToolAnnotations": { "description": "ToolAnnotations holds annotations for a tool.", "type": "object", "id": "ToolAnnotations", "properties": { "title": { "description": "A human-readable title for the tool.", "type": "string" }, "openWorldHint": { "description": "If true, this tool may interact with an \"open world\" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.", "type": "boolean" }, "idempotentHint": { "description": "If true, calling the tool repeatedly with the same arguments will have no additional effect on the environment. (This property is meaningful only when `read_only_hint == false`)", "type": "boolean" }, "readOnlyHint": { "description": "If true, the tool does not modify its environment.", "type": "boolean" }, "destructiveHint": { "description": "If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. (This property is meaningful only when `read_only_hint == false`)", "type": "boolean" } } }, "ExchangeAuthCodeRequest": { "properties": { "authCodeData": { "description": "Optional. AuthCodeData contains the data the runtime requires to exchange for access and refresh tokens. If the data is not provided, the runtime will read the data from the secret manager.", "$ref": "AuthCodeData" }, "oauth2Config": { "description": "OAuth2Config contains the OAuth2 config for the connection.", "$ref": "OAuth2Config" }, "executionConfig": { "description": "ExecutionConfig contains the configuration for the execution of the request.", "$ref": "ExecutionConfig" } }, "id": "ExchangeAuthCodeRequest", "description": "ExchangeAuthCodeRequest currently includes the auth code data.", "type": "object" }, "GenerateCustomToolspecRequest": { "type": "object", "id": "GenerateCustomToolspecRequest", "properties": { "toolNames": { "description": "list of tools to be generated.", "type": "array", "items": { "$ref": "ToolName" } } } }, "OAuth2Config": { "id": "OAuth2Config", "properties": { "clientSecret": { "description": "Client secret for the OAuth2 flow.", "type": "string" }, "authUri": { "description": "Authorization Server URL/Token Endpoint for Authorization Code Flow", "type": "string" }, "clientId": { "description": "Client ID for the OAuth2 flow.", "type": "string" } }, "type": "object" }, "ExecuteToolRequest": { "description": "Request message for ConnectorAgentService.ExecuteTool", "type": "object", "properties": { "executionConfig": { "description": "execution config for the request.", "$ref": "ExecutionConfig" }, "parameters": { "description": "Input parameters for the tool.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "toolDefinition": { "description": "Tool definition for the tool to be executed.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "ExecuteToolRequest" }, "MaintenanceSettings": { "id": "MaintenanceSettings", "properties": { "maintenancePolicies": { "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the embedded policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_policy_names is set. If only the name is needed, then only populate MaintenancePolicy.name.", "type": "object", "additionalProperties": { "$ref": "MaintenancePolicy" } }, "exclude": { "description": "Optional. Exclude instance from maintenance. When true, rollout service will not attempt maintenance on the instance. Rollout service will include the instance in reported rollout progress as not attempted.", "type": "boolean" }, "isRollback": { "description": "Optional. If the update call is triggered from rollback, set the value as true.", "type": "boolean" } }, "description": "Maintenance settings associated with instance. Allows service producers and end users to assign settings that controls maintenance on this instance.", "type": "object" }, "ExecuteToolResponse": { "id": "ExecuteToolResponse", "properties": { "_meta": { "description": "Metadata for the tool execution result.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "result": { "description": "Output from the tool execution.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "description": "Response message for ConnectorAgentService.ExecuteTool", "type": "object" }, "ExecuteActionRequest": { "description": "Request message for ActionService.ExecuteAction", "type": "object", "properties": { "parameters": { "description": "Parameters for executing the action. The parameters can be key/value pairs or nested structs.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "executionConfig": { "description": "Execution config for the request.", "$ref": "ExecutionConfig" } }, "id": "ExecuteActionRequest" }, "ExecuteHttpRequestRequest": { "properties": { "httpMethod": { "enumDescriptions": [ "", "", "", "", "", "", "", "" ], "description": "Required. The HTTP method to use for the request.", "type": "string", "enum": [ "HTTP_METHOD_UNSPECIFIED", "HTTP_METHOD_GET", "HTTP_METHOD_POST", "HTTP_METHOD_PUT", "HTTP_METHOD_PATCH", "HTTP_METHOD_DELETE", "HTTP_METHOD_HEAD", "HTTP_METHOD_OPTIONS" ] }, "url": { "description": "Required. The fully resolved absolute target URL. Callers must pre-encode any query parameters.", "type": "string" }, "headers": { "items": { "$ref": "HttpHeader" }, "description": "HTTP headers to send with the request (e.g., Content-Type: application/json). Order is preserved and duplicate keys are allowed.", "type": "array" }, "rawBody": { "description": "Raw byte payload. Used for all pre-serialized formats including JSON, XML, GraphQL, and Multipart.", "type": "string", "format": "byte" } }, "id": "ExecuteHttpRequestRequest", "type": "object" }, "GetResourceResponse": { "id": "GetResourceResponse", "properties": { "data": { "format": "byte", "description": "The content of the resource.", "type": "string" }, "_meta": { "description": "Metadata for the resource.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "mimeType": { "description": "The MIME type of the resource.", "type": "string" }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "type": "object" }, "AccessCredentials": { "description": "AccessCredentials includes the OAuth access token, and the other fields returned along with it.", "type": "object", "id": "AccessCredentials", "properties": { "accessToken": { "description": "OAuth access token.", "type": "string" }, "expiresIn": { "format": "google-duration", "description": "Duration till the access token expires.", "type": "string" }, "refreshToken": { "description": "OAuth refresh token.", "type": "string" } } }, "DailyCycle": { "description": "Time window specified for daily operations.", "type": "object", "properties": { "startTime": { "description": "Time within the day to start the operations.", "$ref": "TimeOfDay" }, "duration": { "format": "google-duration", "description": "Output only. Duration of the time window, set by service producer.", "type": "string" } }, "id": "DailyCycle" }, "ListResourcesResponse": { "id": "ListResourcesResponse", "properties": { "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "resources": { "items": { "$ref": "Resource" }, "description": "List of available resources.", "type": "array" }, "nextPageToken": { "description": "Next page token if more resources available.", "type": "string" } }, "type": "object" }, "TimeOfDay": { "properties": { "hours": { "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "type": "integer", "format": "int32" }, "minutes": { "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "type": "integer", "format": "int32" }, "seconds": { "format": "int32", "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "type": "integer" }, "nanos": { "format": "int32", "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "type": "integer" } }, "id": "TimeOfDay", "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "type": "object" }, "ResultMetadata": { "id": "ResultMetadata", "properties": { "jsonSchema": { "description": "JsonSchema of the result, applicable only if parameter is of type `STRUCT`", "$ref": "JsonSchema" }, "name": { "description": "Name of the metadata field.", "type": "string" }, "nullable": { "description": "Specifies whether a null value is allowed.", "type": "boolean" }, "description": { "description": "A brief description of the metadata field.", "type": "string" }, "dataType": { "description": "The data type of the metadata field", "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", "Small int type.", "Double type.", "Date type.", "Deprecated Datetime type.", "Time type.", "Deprecated string type, use VARCHAR type instead.", "Deprecated Long type, use BIGINT type instead.", "Boolean type.", "Decimal type.", "Deprecated UUID type, use VARCHAR instead.", "Blob type.", "Bit type.", "Tiny int type.", "Integer type.", "Big int type.", "Float type.", "Real type.", "Numeric type.", "Char type.", "Varchar type.", "Long varchar type.", "Timestamp type.", "Nchar type.", "Nvarchar type.", "Long Nvarchar type.", "Null type.", "Other type.", "Java object type.", "Distinct type keyword.", "Struct type.", "Array type.", "Clob type.", "Ref type.", "Datalink type.", "Row ID type.", "Binary type.", "Varbinary type.", "Long Varbinary type.", "Nclob type.", "SQLXML type.", "Ref_cursor type.", "Time with timezone type.", "Timestamp with timezone type." ], "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 ], "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "INT", "SMALLINT", "DOUBLE", "DATE", "DATETIME", "TIME", "STRING", "LONG", "BOOLEAN", "DECIMAL", "UUID", "BLOB", "BIT", "TINYINT", "INTEGER", "BIGINT", "FLOAT", "REAL", "NUMERIC", "CHAR", "VARCHAR", "LONGVARCHAR", "TIMESTAMP", "NCHAR", "NVARCHAR", "LONGNVARCHAR", "NULL", "OTHER", "JAVA_OBJECT", "DISTINCT", "STRUCT", "ARRAY", "CLOB", "REF", "DATALINK", "ROWID", "BINARY", "VARBINARY", "LONGVARBINARY", "NCLOB", "SQLXML", "REF_CURSOR", "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ] }, "defaultValue": { "description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", "type": "any" } }, "description": "Result Metadata message contains metadata about the result returned after executing an Action.", "type": "object" }, "Schedule": { "properties": { "startTime": { "description": "Time within the window to start the operations.", "$ref": "TimeOfDay" }, "day": { "description": "Allows to define schedule that runs specified day of the week.", "type": "string", "enum": [ "DAY_OF_WEEK_UNSPECIFIED", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "enumDescriptions": [ "The day of the week is unspecified.", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ] }, "duration": { "format": "google-duration", "description": "Output only. Duration of the time window, set by service producer.", "type": "string" } }, "id": "Schedule", "description": "Configure the schedule.", "type": "object" }, "DenyMaintenancePeriod": { "id": "DenyMaintenancePeriod", "properties": { "startDate": { "description": "Deny period start date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be the same or after the start.", "$ref": "Date" }, "time": { "description": "Time in UTC when the Blackout period starts on start_date and ends on end_date. This can be: * Full time. * All zeros for 00:00:00 UTC", "$ref": "TimeOfDay" }, "endDate": { "description": "Deny period end date. This can be: * A full date, with non-zero year, month and day values. * A month and day value, with a zero year. Allows recurring deny periods each year. Date matching this period will have to be before the end.", "$ref": "Date" } }, "description": "DenyMaintenancePeriod definition. Maintenance is forbidden within the deny period. The start_date must be less than the end_date.", "type": "object" }, "CheckStatusResponse": { "id": "CheckStatusResponse", "properties": { "description": { "description": "When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state.", "type": "string" }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "state": { "description": "State of the connector.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "ERROR", "AUTH_ERROR" ], "enumDescriptions": [ "State unspecified.", "The connector is active and ready to process runtime requests. This can also mean that from the connector's perspective, the connector is not in an error state and should be able to process runtime requests successfully.", "The connector is in an error state and cannot process runtime requests. An example reason would be that the connection container has some network issues that prevent outbound requests from being sent.", "This is a more specific error state that the developers can opt to use when the connector is facing auth-related errors caused by auth configuration not present, invalid auth credentials, etc." ] } }, "description": "The status of the connector.", "type": "object" }, "QueryParameter": { "description": "Query parameter definition", "type": "object", "id": "QueryParameter", "properties": { "value": { "type": "any" }, "dataType": { "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "INT", "SMALLINT", "DOUBLE", "DATE", "DATETIME", "TIME", "STRING", "LONG", "BOOLEAN", "DECIMAL", "UUID", "BLOB", "BIT", "TINYINT", "INTEGER", "BIGINT", "FLOAT", "REAL", "NUMERIC", "CHAR", "VARCHAR", "LONGVARCHAR", "TIMESTAMP", "NCHAR", "NVARCHAR", "LONGNVARCHAR", "NULL", "OTHER", "JAVA_OBJECT", "DISTINCT", "STRUCT", "ARRAY", "CLOB", "REF", "DATALINK", "ROWID", "BINARY", "VARBINARY", "LONGVARBINARY", "NCLOB", "SQLXML", "REF_CURSOR", "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", "Small int type.", "Double type.", "Date type.", "Deprecated Datetime type.", "Time type.", "Deprecated string type, use VARCHAR type instead.", "Deprecated Long type, use BIGINT type instead.", "Boolean type.", "Decimal type.", "Deprecated UUID type, use VARCHAR instead.", "Blob type.", "Bit type.", "Tiny int type.", "Integer type.", "Big int type.", "Float type.", "Real type.", "Numeric type.", "Char type.", "Varchar type.", "Long varchar type.", "Timestamp type.", "Nchar type.", "Nvarchar type.", "Long Nvarchar type.", "Null type.", "Other type.", "Java object type.", "Distinct type keyword.", "Struct type.", "Array type.", "Clob type.", "Ref type.", "Datalink type.", "Row ID type.", "Binary type.", "Varbinary type.", "Long Varbinary type.", "Nclob type.", "SQLXML type.", "Ref_cursor type.", "Time with timezone type.", "Timestamp with timezone type." ], "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 ] } } }, "ExecutionConfig": { "id": "ExecutionConfig", "properties": { "headers": { "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" } }, "type": "object" }, "InputParameter": { "properties": { "defaultValue": { "description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", "type": "any" }, "dataType": { "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "INT", "SMALLINT", "DOUBLE", "DATE", "DATETIME", "TIME", "STRING", "LONG", "BOOLEAN", "DECIMAL", "UUID", "BLOB", "BIT", "TINYINT", "INTEGER", "BIGINT", "FLOAT", "REAL", "NUMERIC", "CHAR", "VARCHAR", "LONGVARCHAR", "TIMESTAMP", "NCHAR", "NVARCHAR", "LONGNVARCHAR", "NULL", "OTHER", "JAVA_OBJECT", "DISTINCT", "STRUCT", "ARRAY", "CLOB", "REF", "DATALINK", "ROWID", "BINARY", "VARBINARY", "LONGVARBINARY", "NCLOB", "SQLXML", "REF_CURSOR", "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", "Small int type.", "Double type.", "Date type.", "Deprecated Datetime type.", "Time type.", "Deprecated string type, use VARCHAR type instead.", "Deprecated Long type, use BIGINT type instead.", "Boolean type.", "Decimal type.", "Deprecated UUID type, use VARCHAR instead.", "Blob type.", "Bit type.", "Tiny int type.", "Integer type.", "Big int type.", "Float type.", "Real type.", "Numeric type.", "Char type.", "Varchar type.", "Long varchar type.", "Timestamp type.", "Nchar type.", "Nvarchar type.", "Long Nvarchar type.", "Null type.", "Other type.", "Java object type.", "Distinct type keyword.", "Struct type.", "Array type.", "Clob type.", "Ref type.", "Datalink type.", "Row ID type.", "Binary type.", "Varbinary type.", "Long Varbinary type.", "Nclob type.", "SQLXML type.", "Ref_cursor type.", "Time with timezone type.", "Timestamp with timezone type." ], "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 ], "description": "The data type of the Parameter" }, "description": { "description": "A brief description of the Parameter.", "type": "string" }, "additionalDetails": { "description": "The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "nullable": { "description": "Specifies whether a null value is allowed.", "type": "boolean" }, "name": { "description": "Name of the Parameter.", "type": "string" }, "jsonSchema": { "description": "JsonSchema of the parameter, applicable only if parameter is of type `STRUCT`", "$ref": "JsonSchema" } }, "id": "InputParameter", "description": "Input Parameter message contains metadata about the parameters required for executing an Action.", "type": "object" }, "Resource": { "type": "object", "id": "Resource", "properties": { "description": { "description": "A description of what this resource represents.", "type": "string" }, "uri": { "description": "The URI of this resource.", "type": "string" }, "mimeType": { "description": "The MIME type of this resource, if known.", "type": "string" }, "size": { "description": "The size of the raw resource content, in bytes, if known.", "type": "string", "format": "int64" }, "_meta": { "description": "Metadata for the resource.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "name": { "description": "A human-readable name for this resource.", "type": "string" } } }, "Action": { "properties": { "resultMetadata": { "items": { "$ref": "ResultMetadata" }, "description": "List containing the metadata of result fields.", "type": "array" }, "inputJsonSchema": { "description": "JsonSchema representation of this actions's input schema", "$ref": "JsonSchema" }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "name": { "description": "Name of the action.", "type": "string" }, "displayName": { "description": "Display Name of action to be shown on client side", "type": "string" }, "description": { "description": "Brief Description of action", "type": "string" }, "resultJsonSchema": { "description": "JsonSchema representation of this actions's result schema", "$ref": "JsonSchema" }, "inputParameters": { "description": "List containing input parameter metadata.", "type": "array", "items": { "$ref": "InputParameter" } } }, "id": "Action", "description": "Action message contains metadata information about a single action present in the external system.", "type": "object" }, "RefreshAccessTokenResponse": { "properties": { "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "accessCredentials": { "$ref": "AccessCredentials" } }, "id": "RefreshAccessTokenResponse", "description": "RefreshAccessTokenResponse includes the returned access token and its associated credentials.", "type": "object" }, "UpdatePolicy": { "description": "Maintenance policy applicable to instance updates.", "type": "object", "id": "UpdatePolicy", "properties": { "channel": { "enumDescriptions": [ "Unspecified channel.", "Early channel within a customer project.", "Later channel within a customer project.", "! ! The follow channels can ONLY be used if you adopt the new MW system! ! ! NOTE: all WEEK channels are assumed to be under a weekly window. ! There is currently no dedicated channel definitions for Daily windows. ! If you use Daily window, the system will assume a 1d (24Hours) advanced ! notification period b/w EARLY and LATER. ! We may consider support more flexible daily channel specifications in ! the future. WEEK1 == EARLIER with minimum 7d advanced notification. {7d, 14d} The system will treat them equally and will use WEEK1 whenever it can. New customers are encouraged to use this channel annotation.", "WEEK2 == LATER with minimum 14d advanced notification {14d, 21d}.", "WEEK5 == 40d support. minimum 35d advanced notification {35d, 42d}." ], "description": "Optional. Relative scheduling channel applied to resource.", "type": "string", "enum": [ "UPDATE_CHANNEL_UNSPECIFIED", "EARLIER", "LATER", "WEEK1", "WEEK2", "WEEK5" ] }, "window": { "description": "Optional. Maintenance window that is applied to resources covered by this policy.", "$ref": "MaintenanceWindow" }, "denyMaintenancePeriods": { "description": "Deny Maintenance Period that is applied to resource to indicate when maintenance is forbidden. The protocol supports zero-to-many such periods, but the current SLM Rollout implementation only supports zero-to-one.", "type": "array", "items": { "$ref": "DenyMaintenancePeriod" } } } }, "Entity": { "description": "'Entity row'/ 'Entity' refers to a single row of an entity type.", "type": "object", "id": "Entity", "properties": { "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "fields": { "description": "Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.", "type": "object", "additionalProperties": { "type": "any" } }, "name": { "readOnly": true, "description": "Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}", "type": "string" } } }, "Query": { "id": "Query", "properties": { "query": { "description": "Required. Sql query to execute.", "type": "string" }, "queryParameters": { "items": { "$ref": "QueryParameter" }, "description": "In the struct, the value corresponds to the value of query parameter and date type corresponds to the date type of the query parameter.", "type": "array" }, "timeout": { "format": "int64", "description": "Sets the number of seconds the driver will wait for a query to execute.", "type": "string" }, "maxRows": { "description": "Sets the limit for the maximum number of rows returned after the query execution.", "type": "string", "format": "int64" } }, "description": "A wrapper around the SQL query statement. This is needed so that the JSON representation of ExecuteSqlQueryRequest has the following format: `{\"query\":\"select *\"}`.", "type": "object" }, "JsonSchema": { "properties": { "additionalDetails": { "description": "Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "type": { "items": { "type": "string" }, "description": "JSON Schema Validation: A Vocabulary for Structural Validation of JSON", "type": "array" }, "description": { "description": "A description of this schema.", "type": "string" }, "uniqueItems": { "description": "Whether the items in the array field are unique.", "type": "boolean" }, "maximum": { "description": "Maximum value of the number field.", "type": "any" }, "minLength": { "description": "Minimum length of the string field.", "type": "integer", "format": "int32" }, "readOnly": { "description": "Whether the value is read-only.", "type": "boolean" }, "contentEncoding": { "description": "Encoding of the content.", "type": "string" }, "contentMediaType": { "description": "Media type of the content.", "type": "string" }, "writeOnly": { "description": "Whether the value is write-only.", "type": "boolean" }, "patternProperties": { "description": "Pattern properties for the schema.", "type": "object", "additionalProperties": { "$ref": "JsonSchema" } }, "properties": { "description": "The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property", "type": "object", "additionalProperties": { "$ref": "JsonSchema" } }, "maxProperties": { "description": "Maximum number of properties.", "type": "integer", "format": "int32" }, "additionalItems": { "description": "Schema for additional items.", "$ref": "JsonSchema" }, "dependencies": { "description": "Dependencies for the schema.", "type": "object", "additionalProperties": { "type": "any" } }, "propertyNames": { "description": "Schema for property names.", "$ref": "JsonSchema" }, "allOf": { "description": "Schema that must be valid against all of the sub-schemas.", "type": "array", "items": { "$ref": "JsonSchema" } }, "definitions": { "description": "Definitions for the schema.", "type": "object", "additionalProperties": { "$ref": "JsonSchema" } }, "else": { "description": "Schema that must be valid if the \"if\" schema is invalid.", "$ref": "JsonSchema" }, "title": { "description": "A title of the schema.", "type": "string" }, "then": { "description": "Schema that must be valid if the \"if\" schema is valid.", "$ref": "JsonSchema" }, "$schema": { "description": "The URI defining the schema.", "type": "string" }, "maxItems": { "description": "Maximum number of items in the array field.", "type": "integer", "format": "int32" }, "$comment": { "description": "A comment on the schema.", "type": "string" }, "if": { "description": "Schema that must be valid if the \"if\" schema is valid.", "$ref": "JsonSchema" }, "not": { "description": "Schema that must not be valid.", "$ref": "JsonSchema" }, "$defs": { "description": "Definitions for the schema.", "type": "object", "additionalProperties": { "$ref": "JsonSchema" } }, "maxLength": { "description": "Maximum length of the string field.", "type": "integer", "format": "int32" }, "const": { "description": "Const value that the data must match.", "type": "any" }, "default": { "description": "The default value of the field or object described by this schema.", "type": "any" }, "pattern": { "description": "Regex pattern of the string field. This is a string value that describes the regular expression that the string value should match.", "type": "string" }, "minProperties": { "description": "Minimum number of properties.", "type": "integer", "format": "int32" }, "enum": { "items": { "type": "any" }, "description": "Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values", "type": "array" }, "$ref": { "description": "A reference to another schema.", "type": "string" }, "multipleOf": { "format": "double", "description": "Number must be a multiple of this value.", "type": "number" }, "$id": { "description": "The URI defining the core schema meta-schema.", "type": "string" }, "items": { "description": "Schema that applies to array values, applicable only if this is of type `array`.", "$ref": "JsonSchema" }, "minimum": { "description": "Minimum value of the number field.", "type": "any" }, "contains": { "description": "Schema that applies to at least one item in an array.", "$ref": "JsonSchema" }, "anyOf": { "description": "Schema that must be valid against at least one of the sub-schemas.", "type": "array", "items": { "$ref": "JsonSchema" } }, "required": { "description": "Whether this property is required.", "type": "array", "items": { "type": "string" } }, "exclusiveMinimum": { "description": "Whether the minimum number value is exclusive.", "type": "any" }, "oneOf": { "description": "Schema that must be valid against at least one of the sub-schemas.", "type": "array", "items": { "$ref": "JsonSchema" } }, "exclusiveMaximum": { "description": "Whether the maximum number value is exclusive.", "type": "any" }, "format": { "description": "Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format", "type": "string" }, "jdbcType": { "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "INT", "SMALLINT", "DOUBLE", "DATE", "DATETIME", "TIME", "STRING", "LONG", "BOOLEAN", "DECIMAL", "UUID", "BLOB", "BIT", "TINYINT", "INTEGER", "BIGINT", "FLOAT", "REAL", "NUMERIC", "CHAR", "VARCHAR", "LONGVARCHAR", "TIMESTAMP", "NCHAR", "NVARCHAR", "LONGNVARCHAR", "NULL", "OTHER", "JAVA_OBJECT", "DISTINCT", "STRUCT", "ARRAY", "CLOB", "REF", "DATALINK", "ROWID", "BINARY", "VARBINARY", "LONGVARBINARY", "NCLOB", "SQLXML", "REF_CURSOR", "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", "Small int type.", "Double type.", "Date type.", "Deprecated Datetime type.", "Time type.", "Deprecated string type, use VARCHAR type instead.", "Deprecated Long type, use BIGINT type instead.", "Boolean type.", "Decimal type.", "Deprecated UUID type, use VARCHAR instead.", "Blob type.", "Bit type.", "Tiny int type.", "Integer type.", "Big int type.", "Float type.", "Real type.", "Numeric type.", "Char type.", "Varchar type.", "Long varchar type.", "Timestamp type.", "Nchar type.", "Nvarchar type.", "Long Nvarchar type.", "Null type.", "Other type.", "Java object type.", "Distinct type keyword.", "Struct type.", "Array type.", "Clob type.", "Ref type.", "Datalink type.", "Row ID type.", "Binary type.", "Varbinary type.", "Long Varbinary type.", "Nclob type.", "SQLXML type.", "Ref_cursor type.", "Time with timezone type.", "Timestamp with timezone type." ], "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 ], "description": "JDBC datatype of the field." }, "additionalProperties": { "description": "Schema for additional properties.", "$ref": "JsonSchema" }, "minItems": { "description": "Minimum number of items in the array field.", "type": "integer", "format": "int32" }, "examples": { "description": "Examples of the value.", "type": "array", "items": { "type": "any" } } }, "id": "JsonSchema", "description": "JsonSchema representation of schema metadata", "type": "object" }, "ExecuteHttpRequestResponse": { "type": "object", "id": "ExecuteHttpRequestResponse", "properties": { "statusCode": { "description": "The HTTP status code received from the backend.", "type": "integer", "format": "int32" }, "headers": { "items": { "$ref": "HttpHeader" }, "description": "HTTP headers received in the response. Order is preserved and duplicate keys are allowed (e.g., multiple Set-Cookie headers).", "type": "array" }, "reason": { "description": "The HTTP status reason phrase received from the backend (e.g., \"Not Found\"). May be empty if the backend did not provide one.", "type": "string" }, "body": { "description": "The raw response body.", "type": "string", "format": "byte" } } }, "SloEligibility": { "id": "SloEligibility", "properties": { "eligible": { "description": "Whether an instance is eligible or ineligible.", "type": "boolean" }, "reason": { "description": "User-defined reason for the current value of instance eligibility. Usually, this can be directly mapped to the internal state. An empty reason is allowed.", "type": "string" } }, "description": "SloEligibility is a tuple containing eligibility value: true if an instance is eligible for SLO calculation or false if it should be excluded from all SLO-related calculations along with a user-defined reason.", "type": "object" }, "Date": { "id": "Date", "properties": { "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "type": "integer", "format": "int32" }, "day": { "format": "int32", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "type": "integer" }, "month": { "format": "int32", "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer" } }, "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "type": "object" }, "EntityType": { "description": "EntityType message contains metadata information about a single entity type present in the external system.", "type": "object", "properties": { "name": { "description": "The name of the entity type.", "type": "string" }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "jsonSchema": { "description": "JsonSchema representation of this entity's schema", "$ref": "JsonSchema" }, "operations": { "items": { "enumDescriptions": [ "Operation unspecified.", "This operation means entity type supports LIST method.", "This operation means entity type supports GET method.", "This operation means entity type supports CREATE method.", "This operation means entity type supports UPDATE method.", "This operation means entity type supports DELETE method." ], "type": "string", "enum": [ "OPERATION_UNSPECIFIED", "LIST", "GET", "CREATE", "UPDATE", "DELETE" ] }, "type": "array" }, "defaultSortBy": { "type": "string" }, "fields": { "items": { "$ref": "Field" }, "description": "List containing metadata information about each field of the entity type.", "type": "array" } }, "id": "EntityType" }, "NotificationParameter": { "id": "NotificationParameter", "properties": { "values": { "items": { "type": "string" }, "description": "Optional. Array of string values. e.g. instance's replica information.", "type": "array" } }, "description": "Contains notification related data.", "type": "object" }, "ExecuteActionResponse": { "description": "Response message for ActionService.ExecuteAction", "type": "object", "id": "ExecuteActionResponse", "properties": { "results": { "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "description": "In the case of successful invocation of the specified action, the results Struct contains values based on the response of the action invoked. 1. If the action execution produces any entities as a result, they are returned as an array of Structs with the 'key' being the field name and the 'value' being the value of that field in each result row. { 'results': [{'key': 'value'}, ...] }", "type": "array" }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "Empty": { "id": "Empty", "properties": {}, "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object" }, "MaintenancePolicy": { "properties": { "name": { "description": "Required. MaintenancePolicy name using the form: `projects/{project_id}/locations/{location_id}/maintenancePolicies/{maintenance_policy_id}` where {project_id} refers to a GCP consumer project ID, {location_id} refers to a GCP region/zone, {maintenance_policy_id} must be 1-63 characters long and match the regular expression `[a-z0-9]([-a-z0-9]*[a-z0-9])?`.", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Output only. The time when the resource was created.", "type": "string" }, "updateTime": { "description": "Output only. The time when the resource was updated.", "type": "string", "format": "google-datetime" }, "state": { "enumDescriptions": [ "Unspecified state.", "Resource is ready to be used.", "Resource is being deleted. It can no longer be attached to instances." ], "description": "Optional. The state of the policy.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "READY", "DELETING" ] }, "labels": { "description": "Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.", "type": "object", "additionalProperties": { "type": "string" } }, "description": { "description": "Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512.", "type": "string" }, "updatePolicy": { "description": "Maintenance policy applicable to instance update.", "$ref": "UpdatePolicy" } }, "id": "MaintenancePolicy", "description": "Defines policies to service maintenance events.", "type": "object" }, "CheckReadinessResponse": { "id": "CheckReadinessResponse", "properties": { "status": { "type": "string" } }, "description": "Response containing status of the connector for readiness prober.", "type": "object" }, "ExecuteSqlQueryRequest": { "description": "An execute sql query request containing the query and the connection to execute it on.", "type": "object", "id": "ExecuteSqlQueryRequest", "properties": { "query": { "description": "Required. SQL statement passed by clients like Integration Platform, the query is passed as-is to the driver used for interfacing with external systems.", "$ref": "Query" } } }, "AuthCodeData": { "description": "AuthCodeData contains the data the runtime plane will give the connector backend in exchange for access and refresh tokens.", "type": "object", "properties": { "authCode": { "description": "OAuth authorization code.", "type": "string" }, "scopes": { "items": { "type": "string" }, "description": "Scopes the connection will request when the user performs the auth code flow.", "type": "array" }, "pkceVerifier": { "description": "OAuth PKCE verifier, needed if PKCE is enabled for this particular connection.", "type": "string" }, "redirectUri": { "description": "OAuth redirect URI passed in during the auth code flow, required by some OAuth backends.", "type": "string" } }, "id": "AuthCodeData" }, "WeeklyCycle": { "id": "WeeklyCycle", "properties": { "schedule": { "items": { "$ref": "Schedule" }, "description": "User can specify multiple windows in a week. Minimum of 1 window.", "type": "array" } }, "description": "Time window specified for weekly operations.", "type": "object" }, "Reference": { "properties": { "type": { "description": "Name of reference entity type.", "type": "string" }, "name": { "description": "Name of the reference field.", "type": "string" } }, "id": "Reference", "type": "object" }, "ListEntitiesResponse": { "properties": { "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "nextPageToken": { "description": "Next page token if more records are available.", "type": "string" }, "entities": { "items": { "$ref": "Entity" }, "description": "List containing entity rows.", "type": "array" } }, "id": "ListEntitiesResponse", "description": "Response message for EntityService.ListEntities", "type": "object" }, "UpdateEntitiesWithConditionsResponse": { "properties": { "response": { "description": "Response returned by the external system.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "id": "UpdateEntitiesWithConditionsResponse", "description": "Response message for EntityService.UpdateEntitiesWithConditions", "type": "object" }, "ListEntityTypesResponse": { "id": "ListEntityTypesResponse", "properties": { "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "nextPageToken": { "description": "Next page token if more entity types available.", "type": "string" }, "types": { "items": { "$ref": "EntityType" }, "description": "List of metadata related to all entity types.", "type": "array" }, "unsupportedTypeNames": { "items": { "type": "string" }, "description": "List of entity type names which contain unsupported Datatypes. Check datatype.proto for more information.", "type": "array" } }, "description": "Response message for EntityService.ListEntityTypes", "type": "object" }, "GenerateCustomToolspecResponse": { "type": "object", "properties": { "toolSpec": { "description": "tool spec that has tool_defitions array containing the tools for all sted tool_names.", "$ref": "ToolSpec" } }, "id": "GenerateCustomToolspecResponse" }, "ToolSpec": { "type": "object", "properties": { "toolDefinitions": { "description": "List of tool definitions.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "toolSpecVersion": { "description": "Version of the tool spec. Format: providerId/connectorId/versionId/toolSpecId", "type": "string" } }, "id": "ToolSpec" }, "ToolName": { "type": "object", "properties": { "name": { "description": "Tool name that was generated in the list tools call.", "type": "string" }, "entityName": { "description": "Entity name for which the tool was generated.", "type": "string" }, "operation": { "description": "Operation for which the tool was generated.", "type": "string", "enum": [ "OPERATION_UNSPECIFIED", "LIST", "GET", "CREATE", "UPDATE", "DELETE" ], "enumDescriptions": [ "Operation unspecified.", "LIST entities.", "GET entity.", "CREATE entity.", "UPDATE entity.", "DELETE entity." ] } }, "id": "ToolName" }, "ListActionsResponse": { "description": "Response message for ActionService.ListActions", "type": "object", "properties": { "unsupportedActionNames": { "description": "List of actions which contain unsupported Datatypes. Check datatype.proto for more information.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "Next page token if more actions available.", "type": "string" }, "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "actions": { "description": "List of action metadata.", "type": "array", "items": { "$ref": "Action" } } }, "id": "ListActionsResponse" }, "ListCustomToolNamesResponse": { "id": "ListCustomToolNamesResponse", "properties": { "toolNames": { "items": { "$ref": "ToolName" }, "description": "List of custom tools.", "type": "array" } }, "type": "object" }, "Instance": { "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange", "type": "object", "id": "Instance", "properties": { "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "READY", "UPDATING", "REPAIRING", "DELETING", "ERROR" ], "readOnly": true, "description": "Output only. Current lifecycle state of the resource (e.g. if it's being created or ready to use).", "enumDescriptions": [ "Unspecified state.", "Instance is being created.", "Instance has been created and is ready to use.", "Instance is being updated.", "Instance is unheathy and under repair.", "Instance is being deleted.", "Instance encountered an error and is in indeterministic state." ] }, "consumerProjectNumber": { "description": "Optional. The consumer_project_number associated with this Apigee instance. This field is added specifically to support Apigee integration with SLM Rollout and UMM. It represents the numerical project ID of the GCP project that consumes this Apigee instance. It is used for SLM rollout notifications and UMM integration, enabling proper mapping to customer projects and log delivery for Apigee instances. This field complements consumer_project_id and may be used for specific Apigee scenarios where the numerical ID is required.", "type": "string" }, "sloMetadata": { "description": "Output only. SLO metadata for instance classification in the Standardized dataplane SLO platform. See go/cloud-ssa-standard-slo for feature description.", "$ref": "SloMetadata", "readOnly": true }, "maintenanceSchedules": { "description": "The MaintenanceSchedule contains the scheduling information of published maintenance schedule with same key as software_versions.", "type": "object", "additionalProperties": { "$ref": "MaintenanceSchedule" } }, "slmInstanceTemplate": { "description": "Link to the SLM instance template. Only populated when updating SLM instances via SSA's Actuation service adaptor. Service producers with custom control plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they should use software_versions.", "type": "string" }, "maintenanceSettings": { "description": "Optional. The MaintenanceSettings associated with instance.", "$ref": "MaintenanceSettings" }, "consumerDefinedName": { "description": "consumer_defined_name is the name of the instance set by the service consumers. Generally this is different from the `name` field which reperesents the system-assigned id of the instance which the service consumers do not recognize. This is a required field for tenants onboarding to Maintenance Window notifications (go/slm-rollout-maintenance-policies#prerequisites).", "type": "string" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the resource was created.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the resource was last modified.", "type": "string" }, "notificationParameters": { "description": "Optional. notification_parameter are information that service producers may like to include that is not relevant to Rollout. This parameter will only be passed to Gamma and Cloud Logging for notification/logging purpose.", "type": "object", "additionalProperties": { "$ref": "NotificationParameter" } }, "instanceType": { "description": "Optional. The instance_type of this instance of format: projects/{project_number}/locations/{location_id}/instanceTypes/{instance_type_id}. Instance Type represents a high-level tier or SKU of the service that this instance belong to. When enabled(eg: Maintenance Rollout), Rollout uses 'instance_type' along with 'software_versions' to determine whether instance needs an update or not.", "type": "string" }, "labels": { "description": "Optional. Resource labels to represent user provided metadata. Each label is a key-value pair, where both the key and the value are arbitrary strings provided by the user.", "type": "object", "additionalProperties": { "type": "string" } }, "tenantProjectId": { "readOnly": true, "description": "Output only. ID of the associated GCP tenant project. See go/get-instance-metadata.", "type": "string" }, "name": { "description": "Unique name of the resource. It uses the form: `projects/{project_number}/locations/{location_id}/instances/{instance_id}` Note: This name is passed, stored and logged across the rollout system. So use of consumer project_id or any other consumer PII in the name is strongly discouraged for wipeout (go/wipeout) compliance. See go/elysium/project_ids#storage-guidance for more details.", "type": "string" }, "maintenancePolicyNames": { "description": "Optional. The MaintenancePolicies that have been attached to the instance. The key must be of the type name of the oneof policy name defined in MaintenancePolicy, and the referenced policy must define the same policy type. For details, please refer to go/mr-user-guide. Should not be set if maintenance_settings.maintenance_policies is set.", "type": "object", "additionalProperties": { "type": "string" } }, "producerMetadata": { "description": "Output only. Custom string attributes used primarily to expose producer-specific information in monitoring dashboards. See go/get-instance-metadata.", "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "provisionedResources": { "items": { "$ref": "ProvisionedResource" }, "description": "Output only. The list of data plane resources provisioned for this instance, e.g. compute VMs. See go/get-instance-metadata.", "type": "array", "readOnly": true }, "softwareVersions": { "description": "Software versions that are used to deploy this instance. This can be mutated by rollout services.", "type": "object", "additionalProperties": { "type": "string" } } } }, "ExchangeAuthCodeResponse": { "id": "ExchangeAuthCodeResponse", "properties": { "metadata": { "description": "Metadata like service latency, etc.", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "accessCredentials": { "$ref": "AccessCredentials" } }, "description": "ExchangeAuthCodeResponse includes the returned access token and its associated credentials.", "type": "object" }, "RefreshAccessTokenRequest": { "description": "RefreshAccessTokenRequest includes the refresh token.", "type": "object", "id": "RefreshAccessTokenRequest", "properties": { "executionConfig": { "description": "ExecutionConfig contains the configuration for the execution of the request.", "$ref": "ExecutionConfig" }, "refreshToken": { "description": "Optional. Refresh Token String. If the Refresh Token is not provided, the runtime will read the data from the secret manager.", "type": "string" }, "oauth2Config": { "description": "OAuth2Config contains the OAuth2 config for the connection.", "$ref": "OAuth2Config" } } }, "PerSliSloEligibility": { "description": "PerSliSloEligibility is a mapping from an SLI name to eligibility.", "type": "object", "properties": { "eligibilities": { "description": "An entry in the eligibilities map specifies an eligibility for a particular SLI for the given instance. The SLI key in the name must be a valid SLI name specified in the Eligibility Exporter binary flags otherwise an error will be emitted by Eligibility Exporter and the oncaller will be alerted. If an SLI has been defined in the binary flags but the eligibilities map does not contain it, the corresponding SLI time series will not be emitted by the Eligibility Exporter. This ensures a smooth rollout and compatibility between the data produced by different versions of the Eligibility Exporters. If eligibilities map contains a key for an SLI which has not been declared in the binary flags, there will be an error message emitted in the Eligibility Exporter log and the metric for the SLI in question will not be emitted.", "type": "object", "additionalProperties": { "$ref": "SloEligibility" } } }, "id": "PerSliSloEligibility" }, "Field": { "id": "Field", "properties": { "key": { "description": "The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.", "type": "boolean" }, "additionalDetails": { "description": "The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "nullable": { "description": "Specifies whether a null value is allowed.", "type": "boolean" }, "reference": { "description": "Reference captures the association between two different entity types. Value links to the reference of another entity type.", "$ref": "Reference" }, "defaultValue": { "description": "The following field specifies the default value of the Field provided by the external system if a value is not provided.", "type": "any" }, "dataType": { "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "INT", "SMALLINT", "DOUBLE", "DATE", "DATETIME", "TIME", "STRING", "LONG", "BOOLEAN", "DECIMAL", "UUID", "BLOB", "BIT", "TINYINT", "INTEGER", "BIGINT", "FLOAT", "REAL", "NUMERIC", "CHAR", "VARCHAR", "LONGVARCHAR", "TIMESTAMP", "NCHAR", "NVARCHAR", "LONGNVARCHAR", "NULL", "OTHER", "JAVA_OBJECT", "DISTINCT", "STRUCT", "ARRAY", "CLOB", "REF", "DATALINK", "ROWID", "BINARY", "VARBINARY", "LONGVARBINARY", "NCLOB", "SQLXML", "REF_CURSOR", "TIME_WITH_TIMEZONE", "TIMESTAMP_WITH_TIMEZONE" ], "enumDescriptions": [ "Datatype unspecified.", "Deprecated Int type, use INTEGER type instead.", "Small int type.", "Double type.", "Date type.", "Deprecated Datetime type.", "Time type.", "Deprecated string type, use VARCHAR type instead.", "Deprecated Long type, use BIGINT type instead.", "Boolean type.", "Decimal type.", "Deprecated UUID type, use VARCHAR instead.", "Blob type.", "Bit type.", "Tiny int type.", "Integer type.", "Big int type.", "Float type.", "Real type.", "Numeric type.", "Char type.", "Varchar type.", "Long varchar type.", "Timestamp type.", "Nchar type.", "Nvarchar type.", "Long Nvarchar type.", "Null type.", "Other type.", "Java object type.", "Distinct type keyword.", "Struct type.", "Array type.", "Clob type.", "Ref type.", "Datalink type.", "Row ID type.", "Binary type.", "Varbinary type.", "Long Varbinary type.", "Nclob type.", "SQLXML type.", "Ref_cursor type.", "Time with timezone type.", "Timestamp with timezone type." ], "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 ], "description": "The data type of the Field." }, "jsonSchema": { "description": "JsonSchema of the field, applicable only if field is of type `STRUCT`", "$ref": "JsonSchema" }, "name": { "description": "Name of the Field.", "type": "string" }, "description": { "description": "A brief description of the Field.", "type": "string" } }, "description": "Message contains EntityType's Field metadata.", "type": "object" }, "ListToolsPostRequest": { "id": "ListToolsPostRequest", "properties": { "toolSpec": { "description": "List of tool specifications.", "$ref": "ToolSpec" }, "executionConfig": { "description": "execution config for the request.", "$ref": "ExecutionConfig" }, "toolNames": { "description": "List of tool names to for selective tool fetching.", "type": "array", "items": { "type": "string" } }, "pageToken": { "description": "Page token.", "type": "string" }, "pageSize": { "format": "int32", "description": "Page size.", "type": "integer" } }, "description": "Request message for ConnectorAgentService.ListToolsPost", "type": "object" }, "NodeSloMetadata": { "properties": { "nodeId": { "description": "The id of the node. This should be equal to SaasInstanceNode.node_id.", "type": "string" }, "perSliEligibility": { "description": "If present, this will override eligibility for the node coming from instance or exclusions for specified SLIs.", "$ref": "PerSliSloEligibility" }, "location": { "description": "The location of the node, if different from instance location.", "type": "string" } }, "id": "NodeSloMetadata", "description": "Node information for custom per-node SLO implementations. SSA does not support per-node SLO, but producers can populate per-node information in SloMetadata for custom precomputations. SSA Eligibility Exporter will emit per-node metric based on this information.", "type": "object" }, "HttpHeader": { "description": "A single HTTP header. Keys are case-insensitive. Multiple headers with the same key may be present.", "type": "object", "id": "HttpHeader", "properties": { "key": { "description": "The header name.", "type": "string" }, "value": { "description": "The header value.", "type": "string" } } }, "MaintenanceSchedule": { "description": "Maintenance schedule which is exposed to customer and potentially end user, indicating published upcoming future maintenance schedule", "type": "object", "properties": { "canReschedule": { "deprecated": true, "description": "This field is deprecated, and will be always set to true since reschedule can happen multiple times now. This field should not be removed until all service producers remove this for their customers.", "type": "boolean" }, "scheduleDeadlineTime": { "description": "schedule_deadline_time is the time deadline any schedule start time cannot go beyond, including reschedule. It's normally the initial schedule start time plus maintenance window length (1 day or 1 week). Maintenance cannot be scheduled to start beyond this deadline.", "type": "string", "format": "google-datetime" }, "startTime": { "description": "The scheduled start time for the maintenance.", "type": "string", "format": "google-datetime" }, "endTime": { "description": "The scheduled end time for the maintenance.", "type": "string", "format": "google-datetime" }, "rolloutManagementPolicy": { "description": "The rollout management policy this maintenance schedule is associated with. When doing reschedule update request, the reschedule should be against this given policy.", "type": "string" } }, "id": "MaintenanceSchedule" }, "GetResourcePostRequest": { "description": "Request message for ConnectorAgentService.GetResourcePost", "type": "object", "id": "GetResourcePostRequest", "properties": { "executionConfig": { "description": "execution config for the request.", "$ref": "ExecutionConfig" }, "toolSpec": { "description": "List of tool specifications.", "$ref": "ToolSpec" } } }, "Tool": { "description": "Message representing a single tool.", "type": "object", "id": "Tool", "properties": { "description": { "description": "Description of the tool.", "type": "string" }, "annotations": { "description": "Annotations for the tool.", "$ref": "ToolAnnotations" }, "outputSchema": { "description": "JSON schema for the output of the tool.", "$ref": "JsonSchema" }, "name": { "description": "Name of the tool.", "type": "string" }, "inputSchema": { "description": "JSON schema for the input parameters of the tool.", "$ref": "JsonSchema" }, "dependsOn": { "description": "List of tool names that this tool depends on.", "type": "array", "items": { "type": "string" } }, "_meta": { "description": "Metadata for the tool.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } }, "ExecuteSqlQueryResponse": { "description": "A response returned by the connection after executing the sql query.", "type": "object", "id": "ExecuteSqlQueryResponse", "properties": { "results": { "description": "In the case of successful execution of the query the response contains results returned by the external system. For example, the result rows of the query are contained in the 'results' Struct list - \"results\": [ { \"field1\": \"val1\", \"field2\": \"val2\",.. },.. ] Each Struct row can contain fields any type of like nested Structs or lists.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } } } }, "MaintenanceWindow": { "properties": { "dailyCycle": { "description": "Daily cycle.", "$ref": "DailyCycle" }, "weeklyCycle": { "description": "Weekly cycle.", "$ref": "WeeklyCycle" } }, "id": "MaintenanceWindow", "description": "MaintenanceWindow definition.", "type": "object" } }, "protocol": "rest", "title": "Connectors API", "canonicalName": "Connectors", "baseUrl": "https://connectors.googleapis.com/", "servicePath": "", "revision": "20260804", "documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors", "id": "connectors:v2", "resources": { "projects": { "resources": { "locations": { "resources": { "connections": { "resources": { "resources": { "methods": { "getResourcePost": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GetResourceResponse" }, "parameterOrder": [ "name" ], "description": "Gets a specific resource with POST.", "request": { "$ref": "GetResourcePostRequest" }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/resources/{resourcesId}", "id": "connectors.projects.locations.connections.resources.getResourcePost", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Resource name of the Resource. Format: projects/{project}/locations/{location}/connections/{connection}/resources/{resource}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/resources/.*$", "type": "string" } }, "path": "v2/{+name}" }, "get": { "path": "v2/{+name}", "id": "connectors.projects.locations.connections.resources.get", "parameters": { "name": { "type": "string", "description": "Required. Resource name of the Resource. Format: projects/{project}/locations/{location}/connections/{connection}/resources/{resource}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/resources/.*$", "location": "path", "required": true }, "executionConfig.headers": { "location": "query", "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/resources/{resourcesId}", "parameterOrder": [ "name" ], "description": "Gets a specific resource.", "response": { "$ref": "GetResourceResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "response": { "$ref": "ListResourcesResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Lists all available resources.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/resources", "id": "connectors.projects.locations.connections.resources.list", "parameters": { "parent": { "description": "Required. Resource name of the connection. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "format": "int32", "description": "Optional. Page size for the request.", "type": "integer", "location": "query" }, "executionConfig.headers": { "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string", "location": "query" }, "pageToken": { "description": "Optional. Page token for the request.", "type": "string", "location": "query" } }, "path": "v2/{+parent}/resources" } } }, "entityTypes": { "resources": { "entities": { "methods": { "patch": { "parameterOrder": [ "name" ], "description": "Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system.", "request": { "$ref": "Entity" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Entity" }, "id": "connectors.projects.locations.connections.entityTypes.entities.patch", "parameters": { "name": { "location": "path", "required": true, "description": "Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$", "type": "string" }, "executionConfig.headers": { "location": "query", "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" } }, "path": "v2/{+name}", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}" }, "list": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities", "path": "v2/{+parent}/entities", "id": "connectors.projects.locations.connections.entityTypes.entities.list", "parameters": { "sortBy": { "location": "query", "description": "List of 'sort_by' columns to use when returning the results.", "repeated": true, "type": "string" }, "executionConfig.headers": { "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string", "location": "query" }, "parent": { "type": "string", "location": "path", "required": true, "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$" }, "pageSize": { "location": "query", "description": "Number of entity rows to return. Defaults page size = 25. Max page size = 200.", "type": "integer", "format": "int32" }, "conditions": { "location": "query", "description": "Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported.", "type": "string" }, "pageToken": { "description": "Page token value if available from a previous request.", "type": "string", "location": "query" }, "sortOrder": { "location": "query", "description": "List of 'sort_order' columns to use when returning the results.", "repeated": true, "type": "string" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListEntitiesResponse" }, "parameterOrder": [ "parent" ], "description": "Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors." }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes an existing entity row matching the entity type and entity id specified in the request.", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}", "id": "connectors.projects.locations.connections.entityTypes.entities.delete", "parameters": { "name": { "type": "string", "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$", "location": "path", "required": true }, "executionConfig.headers": { "location": "query", "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}" }, "create": { "parameterOrder": [ "parent" ], "description": "Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a `Entity` message object returned as a response by the external system.", "request": { "$ref": "Entity" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Entity" }, "id": "connectors.projects.locations.connections.entityTypes.entities.create", "parameters": { "parent": { "type": "string", "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true }, "executionConfig.headers": { "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string", "location": "query" } }, "path": "v2/{+parent}/entities", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities" }, "get": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities/{entitiesId}", "id": "connectors.projects.locations.connections.entityTypes.entities.get", "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+/entities/[^/]+$" }, "executionConfig.headers": { "location": "query", "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" } }, "path": "v2/{+name}", "response": { "$ref": "Entity" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets a single entity row matching the entity type and entity id specified in the request." }, "updateEntitiesWithConditions": { "id": "connectors.projects.locations.connections.entityTypes.entities.updateEntitiesWithConditions", "parameters": { "entityType": { "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true, "type": "string" }, "conditions": { "description": "Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.", "type": "string", "location": "query" }, "executionConfig.headers": { "location": "query", "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" } }, "path": "v2/{+entityType}/entities:updateEntitiesWithConditions", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:updateEntitiesWithConditions", "request": { "$ref": "Entity" }, "parameterOrder": [ "entityType" ], "description": "Updates entities based on conditions specified in the request and not on entity id.", "response": { "$ref": "UpdateEntitiesWithConditionsResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "deleteEntitiesWithConditions": { "parameterOrder": [ "entityType" ], "description": "Deletes entities based on conditions specified in the request and not on entity id.", "response": { "$ref": "Empty" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "connectors.projects.locations.connections.entityTypes.entities.deleteEntitiesWithConditions", "parameters": { "entityType": { "type": "string", "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$", "location": "path", "required": true }, "conditions": { "location": "query", "description": "Required. Conditions to be used when deleting entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.", "type": "string" }, "executionConfig.headers": { "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string", "location": "query" } }, "path": "v2/{+entityType}/entities:deleteEntitiesWithConditions", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}/entities:deleteEntitiesWithConditions" } } } }, "methods": { "list": { "parameterOrder": [ "parent" ], "description": "Lists metadata related to all entity types present in the external system.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListEntityTypesResponse" }, "path": "v2/{+parent}/entityTypes", "id": "connectors.projects.locations.connections.entityTypes.list", "parameters": { "view": { "description": "Specifies which fields of the Entity Type are returned in the response.", "location": "query", "enumDescriptions": [ "VIEW_UNSPECIFIED. The unset value. Defaults to FULL View.", "Return only entity type names.", "Return entity types with schema" ], "type": "string", "enum": [ "ENTITY_TYPE_VIEW_UNSPECIFIED", "ENTITY_TYPE_VIEW_BASIC", "ENTITY_TYPE_VIEW_FULL" ] }, "parent": { "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Number of entity types to return. Defaults to 25.", "type": "integer" }, "pageToken": { "description": "Page token, return from a previous ListEntityTypes call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of entity types.", "type": "string", "location": "query" }, "executionConfig.headers": { "location": "query", "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes" }, "get": { "parameterOrder": [ "name" ], "description": "Gets metadata of given entity type", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "EntityType" }, "path": "v2/{+name}", "id": "connectors.projects.locations.connections.entityTypes.get", "parameters": { "view": { "type": "string", "enum": [ "ENTITY_TYPE_SCHEMA_VIEW_UNSPECIFIED", "ENTITY_TYPE_SCHEMA_VIEW_BASIC", "ENTITY_TYPE_SCHEMA_VIEW_ENRICHED" ], "location": "query", "enumDescriptions": [ "VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.", "Return basic entity type schema.", "Return enriched entity types schema." ], "description": "Specifies view for entity type schema." }, "contextMetadata": { "location": "query", "description": "Context metadata for request could be used to fetch customization of entity type schema.", "type": "string" }, "name": { "location": "path", "required": true, "description": "Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{entityType}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/entityTypes/[^/]+$", "type": "string" }, "executionConfig.headers": { "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string", "location": "query" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/entityTypes/{entityTypesId}" } } }, "actions": { "methods": { "execute": { "id": "connectors.projects.locations.connections.actions.execute", "parameters": { "name": { "type": "string", "description": "Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$", "location": "path", "required": true } }, "path": "v2/{+name}:execute", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}:execute", "parameterOrder": [ "name" ], "description": "Executes an action with the name specified in the request. The input parameters for executing the action are passed through the body of the ExecuteAction request.", "request": { "$ref": "ExecuteActionRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ExecuteActionResponse" } }, "get": { "response": { "$ref": "Action" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Gets the schema of the given action.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions/{actionsId}", "id": "connectors.projects.locations.connections.actions.get", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}/actions/{action}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/actions/[^/]+$", "type": "string" }, "executionConfig.headers": { "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string", "location": "query" }, "view": { "type": "string", "enum": [ "ACTION_SCHEMA_VIEW_UNSPECIFIED", "ACTION_SCHEMA_VIEW_BASIC", "ACTION_SCHEMA_VIEW_ENRICHED" ], "description": "Specified view of the action schema.", "location": "query", "enumDescriptions": [ "VIEW_UNSPECIFIED. The unset value. Defaults to BASIC View.", "Return basic action schema.", "Return enriched action schema." ] } }, "path": "v2/{+name}" }, "list": { "path": "v2/{+parent}/actions", "id": "connectors.projects.locations.connections.actions.list", "parameters": { "executionConfig.headers": { "location": "query", "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" }, "parent": { "description": "Required. Parent resource name of the Action. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Number of Actions to return. Defaults to 25.", "type": "integer" }, "view": { "type": "string", "enum": [ "ACTION_VIEW_UNSPECIFIED", "ACTION_VIEW_BASIC", "ACTION_VIEW_FULL" ], "description": "Specifies which fields of the Action are returned in the response.", "location": "query", "enumDescriptions": [ "VIEW_UNSPECIFIED. The unset value Defaults to FULL View.", "Return only action names.", "Return actions with schema." ] }, "pageToken": { "location": "query", "description": "Page token, return from a previous ListActions call, that can be used retrieve the next page of content. If unspecified, the request returns the first page of actions.", "type": "string" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/actions", "parameterOrder": [ "parent" ], "description": "Gets the schema of all the actions supported by the connector.", "response": { "$ref": "ListActionsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "tools": { "methods": { "list": { "id": "connectors.projects.locations.connections.tools.list", "parameters": { "toolNames": { "location": "query", "description": "List of tool names for selective tool fetching.", "repeated": true, "type": "string" }, "executionConfig.headers": { "location": "query", "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string" }, "parent": { "location": "path", "required": true, "description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "Page size.", "type": "integer" }, "pageToken": { "location": "query", "description": "Page token.", "type": "string" } }, "path": "v2/{+parent}/tools", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/tools", "parameterOrder": [ "parent" ], "description": "Lists all available tools.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListToolsResponse" } }, "execute": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/tools/{toolsId}:execute", "id": "connectors.projects.locations.connections.tools.execute", "parameters": { "name": { "description": "Required. Resource name of the Tool. Format: projects/{project}/locations/{location}/connections/{connection}/tools/{tool}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/tools/[^/]+$", "location": "path", "required": true, "type": "string" } }, "path": "v2/{+name}:execute", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ExecuteToolResponse" }, "parameterOrder": [ "name" ], "description": "Executes a specific tool.", "request": { "$ref": "ExecuteToolRequest" } } } } }, "methods": { "listCustomToolNames": { "parameterOrder": [ "name" ], "description": "Lists custom tool names.", "response": { "$ref": "ListCustomToolNamesResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}:listCustomToolNames", "id": "connectors.projects.locations.connections.listCustomToolNames", "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:listCustomToolNames" }, "exchangeAuthCode": { "id": "connectors.projects.locations.connections.exchangeAuthCode", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "type": "string", "location": "path", "required": true } }, "path": "v2/{+name}:exchangeAuthCode", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:exchangeAuthCode", "parameterOrder": [ "name" ], "description": "ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).", "request": { "$ref": "ExchangeAuthCodeRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ExchangeAuthCodeResponse" } }, "tools": { "parameterOrder": [ "parent" ], "description": "Lists all available tools with POST.", "request": { "$ref": "ListToolsPostRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListToolsResponse" }, "path": "v2/{+parent}/tools", "id": "connectors.projects.locations.connections.tools", "parameters": { "parent": { "type": "string", "description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "location": "path", "required": true } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/tools" }, "executeSqlQuery": { "response": { "$ref": "ExecuteSqlQueryResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "ExecuteSqlQueryRequest" }, "parameterOrder": [ "connection" ], "description": "Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:executeSqlQuery", "id": "connectors.projects.locations.connections.executeSqlQuery", "parameters": { "connection": { "type": "string", "location": "path", "required": true, "description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$" } }, "path": "v2/{+connection}:executeSqlQuery" }, "generateConnectionToolspecOverride": { "parameterOrder": [ "name" ], "description": "Generate toolspec override for the given list of toolNames.", "request": { "$ref": "GenerateCustomToolspecRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GenerateCustomToolspecResponse" }, "path": "v2/{+name}:generateConnectionToolspecOverride", "id": "connectors.projects.locations.connections.generateConnectionToolspecOverride", "parameters": { "name": { "description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "location": "path", "required": true, "type": "string" } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:generateConnectionToolspecOverride" }, "executeHttpRequest": { "request": { "$ref": "ExecuteHttpRequestRequest" }, "parameterOrder": [ "name" ], "description": "Executes a generic HTTP request. This supports all payload formats including REST/JSON, GraphQL, XML, SOAP, and Multipart by passing the rendered payload as raw bytes.", "response": { "$ref": "ExecuteHttpRequestResponse" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "connectors.projects.locations.connections.executeHttpRequest", "parameters": { "name": { "location": "path", "required": true, "description": "Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "type": "string" } }, "path": "v2/{+name}:executeHttpRequest", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:executeHttpRequest" }, "refreshAccessToken": { "path": "v2/{+name}:refreshAccessToken", "id": "connectors.projects.locations.connections.refreshAccessToken", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "type": "string", "location": "path", "required": true } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:refreshAccessToken", "parameterOrder": [ "name" ], "description": "RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).", "request": { "$ref": "RefreshAccessTokenRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "RefreshAccessTokenResponse" } }, "checkStatus": { "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkStatus", "id": "connectors.projects.locations.connections.checkStatus", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "type": "string" }, "executionConfig.headers": { "description": "headers to be used for the request. For example: headers:'{\"x-integration-connectors-managed-connection-id\":\"conn-id\",\"x-integration-connectors-runtime-config\":\"runtime-cfg\"}'", "type": "string", "location": "query" } }, "path": "v2/{+name}:checkStatus", "response": { "$ref": "CheckStatusResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not \"OK\", which indicates that ConnectionStatus itself, not the connection, failed." }, "checkReadiness": { "parameterOrder": [ "name" ], "description": "Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.", "response": { "$ref": "CheckReadinessResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v2/{+name}:checkReadiness", "id": "connectors.projects.locations.connections.checkReadiness", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "type": "string", "location": "path", "required": true } }, "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkReadiness" } } } } } } } }, "fullyEncodeReservedExpansion": true, "kind": "discovery#restDescription", "version_module": true, "rootUrl": "https://connectors.googleapis.com/", "ownerName": "Google", "parameters": { "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "$.xgafv": { "type": "string", "enum": [ "1", "2" ], "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "fields": { "location": "query", "type": "string", "description": "Selector specifying which fields to include in a partial response." }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "alt": { "description": "Data format for response.", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string", "enum": [ "json", "media", "proto" ] }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "prettyPrint": { "default": "true", "location": "query", "type": "boolean", "description": "Returns response with indentations and line breaks." }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." } }, "version": "v2", "ownerDomain": "google.com", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "name": "connectors", "batchPath": "batch", "endpoints": [ { "description": "Regional Endpoint", "endpointUrl": "https://connectors.us-central1.rep.googleapis.com/", "location": "us-central1" }, { "endpointUrl": "https://connectors.us-east1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-east1" }, { "location": "us-east4", "endpointUrl": "https://connectors.us-east4.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-east5", "endpointUrl": "https://connectors.us-east5.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-south1", "endpointUrl": "https://connectors.us-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://connectors.us-west1.rep.googleapis.com/", "description": "Regional Endpoint", "location": "us-west1" }, { "location": "us-west2", "description": "Regional Endpoint", "endpointUrl": "https://connectors.us-west2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://connectors.us-west3.rep.googleapis.com/", "location": "us-west3" }, { "location": "us-west4", "description": "Regional Endpoint", "endpointUrl": "https://connectors.us-west4.rep.googleapis.com/" } ], "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" } }