{ "id": "integrations:v1", "discoveryVersion": "v1", "basePath": "", "rootUrl": "https://integrations.googleapis.com/", "fullyEncodeReservedExpansion": true, "documentationLink": "https://cloud.google.com/application-integration", "title": "Application Integration API", "mtlsRootUrl": "https://integrations.mtls.googleapis.com/", "revision": "20261018", "batchPath": "batch", "protocol": "rest", "canonicalName": "Integrations", "parameters": { "quotaUser": { "location": "query", "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." }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query", "default": "true" }, "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." }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "$.xgafv": { "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "enum": [ "1", "2" ] }, "alt": { "default": "json", "description": "Data format for response.", "type": "string", "enum": [ "json", "media", "proto" ], "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" } }, "baseUrl": "https://integrations.googleapis.com/", "ownerName": "Google", "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." } } } }, "version": "v1", "description": "", "ownerDomain": "google.com", "version_module": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "kind": "discovery#restDescription", "schemas": { "EnterpriseCrmEventbusProtoParamSpecEntryValidationRule": { "id": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRule", "properties": { "stringRegex": { "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex" }, "doubleRange": { "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange" }, "intRange": { "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange" } }, "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoParameterMapField": { "properties": { "literalValue": { "description": "Passing a literal value.", "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType" }, "referenceKey": { "type": "string", "description": "Referencing one of the WF variables." } }, "id": "EnterpriseCrmFrontendsEventbusProtoParameterMapField", "description": "Field represents either the key or value in an entry.", "type": "object" }, "GoogleCloudConnectorsV1DestinationConfig": { "description": "Define the Connectors target endpoint.", "id": "GoogleCloudConnectorsV1DestinationConfig", "properties": { "key": { "type": "string", "description": "Optional. The key is the destination identifier that is supported by the Connector." }, "destinations": { "description": "Optional. The destinations for the key.", "type": "array", "items": { "$ref": "GoogleCloudConnectorsV1Destination" } } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaAttemptStats": { "description": "Status for the execution attempt.", "id": "GoogleCloudIntegrationsV1alphaAttemptStats", "properties": { "endTime": { "type": "string", "format": "google-datetime", "description": "The end time of the integration execution for current attempt." }, "startTime": { "description": "The start time of the integration execution for current attempt. This could be in the future if it's been scheduled.", "format": "google-datetime", "type": "string" } }, "type": "object" }, "EnterpriseCrmEventbusProtoTeardownTaskConfig": { "id": "EnterpriseCrmEventbusProtoTeardownTaskConfig", "properties": { "parameters": { "description": "The parameters the user can pass to this task.", "$ref": "EnterpriseCrmEventbusProtoEventParameters" }, "properties": { "$ref": "EnterpriseCrmEventbusProtoEventBusProperties" }, "name": { "description": "Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.", "type": "string" }, "teardownTaskImplementationClassName": { "description": "Required. Implementation class name.", "type": "string" }, "nextTeardownTask": { "$ref": "EnterpriseCrmEventbusProtoNextTeardownTask" }, "creatorEmail": { "description": "The creator's email address.", "type": "string" } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaCancelExecutionRequest": { "id": "GoogleCloudIntegrationsV1alphaCancelExecutionRequest", "type": "object", "properties": { "cancelReason": { "description": "Required. Reason for cancelling the execution. This is provided by the client requesting the cancellation, and is not used by the Platform.", "type": "string" } }, "description": "Request for cancelling an execution." }, "EnterpriseCrmEventbusProtoCustomSuspensionRequest": { "id": "EnterpriseCrmEventbusProtoCustomSuspensionRequest", "properties": { "suspensionInfoEventParameterKey": { "type": "string", "description": "In the fired event, set the SuspensionInfo message as the value for this key." }, "postToQueueWithTriggerIdRequest": { "description": "Request to fire an event containing the SuspensionInfo message.", "$ref": "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest" } }, "type": "object" }, "EnterpriseCrmEventbusProtoTaskExecutionDetails": { "properties": { "taskAttemptStats": { "items": { "$ref": "EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats" }, "type": "array" }, "taskExecutionState": { "enumDescriptions": [ "", "Task is waiting for its precondition tasks to finish to start the execution.", "Task is under processing.", "Task execution successfully finished. There's no more change after this state.", "Task execution failed. There's no more change after this state.", "Task execution failed and cause the whole event execution to fail immediately. There's no more change after this state.", "Task execution failed and waiting for retry.", "Task execution skipped. This happens when its precondition wasn't met, or the event execution been canceled before reach to the task. There's no more changes after this state.", "Task execution canceled when in progress. This happens when event execution been canceled or any other task fall in fatal state.", "Task is waiting for its dependency tasks' rollback to finish to start its rollback.", "Task is rolling back.", "Task is rolled back. This is the state we will set regardless of rollback succeeding or failing.", "Task is a SuspensionTask which has executed once, creating a pending suspension." ], "type": "string", "enum": [ "UNSPECIFIED", "PENDING_EXECUTION", "IN_PROCESS", "SUCCEED", "FAILED", "FATAL", "RETRY_ON_HOLD", "SKIPPED", "CANCELED", "PENDING_ROLLBACK", "ROLLBACK_IN_PROCESS", "ROLLEDBACK", "SUSPENDED" ] }, "skippedOnFailure": { "type": "boolean", "description": "Indicates whether the task was skipped on failure. Only relevant if the task is in SKIPPED state." }, "taskNumber": { "description": "Pointer to the task config it used for execution.", "type": "string" } }, "description": "Contains the details of the execution of this task. Next available id: 11", "id": "EnterpriseCrmEventbusProtoTaskExecutionDetails", "type": "object" }, "EnterpriseCrmEventbusProtoCloudLoggingDetails": { "properties": { "cloudLoggingSeverity": { "type": "string", "enum": [ "CLOUD_LOGGING_SEVERITY_UNSPECIFIED", "INFO", "ERROR", "WARNING" ], "description": "Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.", "enumDescriptions": [ "Unspecified", "If Severity selected is `INFO`, then all the Integration Execution States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, `ERROR`, `CANCELLED`) will be sent to Cloud Logging.", "If Severity selected is `ERROR`, then only the following Integration Execution States (`ERROR`, `CANCELLED`) will be sent to Cloud Logging.", "If Severity selected is `WARNING`, then only the following Integration Execution States (`ERROR`, `CANCELLED`) will be sent to Cloud Logging." ] }, "enableCloudLogging": { "type": "boolean", "description": "Status of whether Cloud Logging is enabled or not for the integration version getting executed." } }, "description": "Cloud Logging details, selected by the user for the integration version (workflow). This message field will be also used in ExecutionInfo, to indicate the CloudLoggingDetails config at the time of workflow (integration version) execution, since this field value can be changed for an unpublished workflow.", "type": "object", "id": "EnterpriseCrmEventbusProtoCloudLoggingDetails" }, "EnterpriseCrmEventbusProtoSuspensionResolutionInfo": { "type": "object", "id": "EnterpriseCrmEventbusProtoSuspensionResolutionInfo", "properties": { "lastModifiedTimestamp": { "description": "Auto-generated.", "type": "string", "format": "google-datetime" }, "audit": { "$ref": "EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit" }, "status": { "enumDescriptions": [ "", "", "", "" ], "type": "string", "enum": [ "PENDING_UNSPECIFIED", "REJECTED", "LIFTED", "CANCELED" ] }, "wrappedDek": { "format": "byte", "description": "Wrapped dek", "type": "string" }, "product": { "type": "string", "enum": [ "UNSPECIFIED_PRODUCT", "IP", "APIGEE", "SECURITY" ], "enumDescriptions": [ "", "", "", "" ], "description": "Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default." }, "createdTimestamp": { "format": "google-datetime", "description": "Auto-generated.", "type": "string" }, "cloudKmsConfig": { "$ref": "EnterpriseCrmEventbusProtoCloudKmsConfig", "description": "KMS info, used by cmek/gmek integration" }, "suspensionId": { "type": "string", "description": "Primary key for the SuspensionResolutionInfoTable." }, "suspensionConfig": { "$ref": "EnterpriseCrmEventbusProtoSuspensionConfig" }, "encryptedSuspensionResolutionInfo": { "type": "string", "description": "Encrypted SuspensionResolutionInfo", "format": "byte" }, "taskNumber": { "type": "string", "description": "Required. Task number of the associated SuspensionTask." }, "workflowName": { "type": "string", "description": "Required. The name of the originating workflow." }, "eventExecutionInfoId": { "type": "string", "description": "Required. ID of the associated execution." }, "clientId": { "type": "string", "description": "The event data user sends as request." }, "externalTraffic": { "$ref": "EnterpriseCrmEventbusProtoExternalTraffic", "description": "The origin of the suspension for periodic notifications." } } }, "EnterpriseCrmEventbusProtoBooleanParameterArray": { "id": "EnterpriseCrmEventbusProtoBooleanParameterArray", "properties": { "booleanValues": { "type": "array", "items": { "type": "boolean" } } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaCloudLoggingDetails": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaCloudLoggingDetails", "description": "Cloud Logging details for execution info", "properties": { "cloudLoggingSeverity": { "type": "string", "enum": [ "CLOUD_LOGGING_SEVERITY_UNSPECIFIED", "INFO", "ERROR", "WARNING" ], "description": "Optional. Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.", "enumDescriptions": [ "Unspecified", "If Severity selected is `INFO`, then all the Integration Execution States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, `ERROR`, `CANCELLED`) will be sent to Cloud Logging.", "If Severity selected is `ERROR`, then only the following Integration Execution States (`ERROR`, `CANCELLED`) will be sent to Cloud Logging.", "If Severity selected is `WARNING`, then only the following Integration Execution States (`ERROR`, `CANCELLED`) will be sent to Cloud Logging." ] }, "enableCloudLogging": { "description": "Optional. Status of whether Cloud Logging is enabled or not for the integration version getting executed.", "type": "boolean" } } }, "EnterpriseCrmEventbusProtoNotification": { "properties": { "request": { "$ref": "EnterpriseCrmEventbusProtoCustomSuspensionRequest", "description": "If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution." }, "escalatorQueue": { "type": "string" }, "emailAddress": { "$ref": "EnterpriseCrmEventbusProtoAddress" }, "buganizerNotification": { "$ref": "EnterpriseCrmEventbusProtoBuganizerNotification" }, "pubsubTopic": { "type": "string" } }, "type": "object", "id": "EnterpriseCrmEventbusProtoNotification" }, "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo": { "properties": { "replayReason": { "description": "reason for replay", "type": "string" }, "replayedExecutionInfoIds": { "items": { "type": "string" }, "description": "If this execution has been replayed, then this field contains the execution ids of the replayed executions.", "type": "array" }, "replayMode": { "enumDescriptions": [ "", "Replay the original execution from the beginning.", "Replay the execution from the first failed task." ], "description": "Replay mode for the execution", "type": "string", "enum": [ "REPLAY_MODE_UNSPECIFIED", "REPLAY_MODE_FROM_BEGINNING", "REPLAY_MODE_POINT_OF_FAILURE" ] }, "originalExecutionInfoId": { "description": "If this execution is a replay of another execution, then this field contains the original execution id.", "type": "string" } }, "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo", "description": "Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship", "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoEventParameters": { "properties": { "parameters": { "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" }, "type": "array", "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution." } }, "description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see", "type": "object", "id": "EnterpriseCrmFrontendsEventbusProtoEventParameters" }, "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse": { "description": "Response for CreateAppsScriptProject rpc call.", "id": "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse", "properties": { "projectId": { "description": "The created AppsScriptProject ID.", "type": "string" } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaChangeCustomerConfigRequest": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaChangeCustomerConfigRequest", "properties": { "customerConfig": { "$ref": "GoogleCloudIntegrationsV1alphaCustomerConfig", "description": "Optional. The customer configuration to be updated." }, "updateMask": { "description": "Required. Field mask specifying the fields in the customer config that have been modified and must be updated. If absent or empty, no fields are updated.", "format": "google-fieldmask", "type": "string" } }, "description": "Request for the ChangeCustomerConfig rpc" }, "EnterpriseCrmEventbusProtoStringArray": { "type": "object", "id": "EnterpriseCrmEventbusProtoStringArray", "properties": { "values": { "items": { "type": "string" }, "type": "array" } } }, "GoogleCloudIntegrationsV1alphaParameterMap": { "id": "GoogleCloudIntegrationsV1alphaParameterMap", "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaParameterMapEntry" }, "description": "A list of parameter map entries." }, "valueType": { "type": "string", "enum": [ "INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "BOOLEAN_ARRAY", "JSON_VALUE", "PROTO_VALUE", "PROTO_ARRAY", "NON_SERIALIZABLE_OBJECT", "PROTO_ENUM", "SERIALIZED_OBJECT_VALUE", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY" ], "enumDescriptions": [ "Unspecified.", "String.", "Integer.", "Double Number.", "Boolean.", "String Array.", "Integer Array.", "Double Number Array.", "Boolean Array.", "Json.", "Proto Value (Internal use only).", "Proto Array (Internal use only).", "// Non-serializable object (Internal use only).", "Proto Enum (Internal use only).", "Serialized object (Internal use only).", "Proto Enum Array (Internal use only).", "BYTES data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields." ], "description": "Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this." }, "keyType": { "type": "string", "enum": [ "INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "BOOLEAN_ARRAY", "JSON_VALUE", "PROTO_VALUE", "PROTO_ARRAY", "NON_SERIALIZABLE_OBJECT", "PROTO_ENUM", "SERIALIZED_OBJECT_VALUE", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY" ], "enumDescriptions": [ "Unspecified.", "String.", "Integer.", "Double Number.", "Boolean.", "String Array.", "Integer Array.", "Double Number Array.", "Boolean Array.", "Json.", "Proto Value (Internal use only).", "Proto Array (Internal use only).", "// Non-serializable object (Internal use only).", "Proto Enum (Internal use only).", "Serialized object (Internal use only).", "Proto Enum Array (Internal use only).", "BYTES data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields." ], "description": "Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this." } }, "description": "A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified." }, "GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse": { "id": "GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse", "type": "object", "properties": { "runtimeEntitySchemas": { "type": "array", "description": "Runtime entity schemas.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaRuntimeEntitySchema" } }, "nextPageToken": { "description": "Next page token.", "type": "string" } }, "description": "Response for listing RuntimeEntitySchemas for a specific Connection." }, "EnterpriseCrmEventbusProtoStringFunction": { "type": "object", "id": "EnterpriseCrmEventbusProtoStringFunction", "properties": { "functionName": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNSPECIFIED", "CONCAT", "TO_UPPERCASE", "TO_LOWERCASE", "CONTAINS", "SPLIT", "LENGTH", "EQUALS", "TO_INT", "TO_DOUBLE", "TO_BOOLEAN", "TO_BASE_64", "TO_JSON", "EQUALS_IGNORE_CASE", "REPLACE_ALL", "SUBSTRING", "RESOLVE_TEMPLATE", "DECODE_BASE64_STRING" ] } } }, "EnterpriseCrmEventbusProtoStringParameterArray": { "properties": { "stringValues": { "type": "array", "items": { "type": "string" } } }, "type": "object", "id": "EnterpriseCrmEventbusProtoStringParameterArray" }, "GoogleCloudIntegrationsV1alphaReplayExecutionRequest": { "properties": { "replayReason": { "description": "Required. The user provided reason for replaying the execution.", "type": "string" }, "replayMode": { "type": "string", "enum": [ "REPLAY_MODE_UNSPECIFIED", "REPLAY_MODE_FROM_BEGINNING", "REPLAY_MODE_POINT_OF_FAILURE" ], "description": "Optional. The mode of the replay.", "enumDescriptions": [ "Default value.", "Replay the original execution.", "Replay the execution with the modified parameters." ] }, "updateMask": { "description": "Optional. The list of parameters to be updated. - If the `update_mask` is not specified, all the parameters from original execution will be ignored and only the `modified_parameters` will be used. - It is an error to include a parameter in `update_mask` but not in `modified_parameters`. - Updating nested fields in a JSON parameter is not supported, please provide the complete JSON in the `modified_parameters`.", "format": "google-fieldmask", "type": "string" }, "modifiedParameters": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, "description": "Optional. The modified input parameters for replay. - Provide values for all the fields in the 'update_mask'. Any field not present in the 'update_mask' will be ignored and its value will be taken from the original execution. - If the 'update_mask' is not specified, all the parameters from original execution will be ignored and only the `modified_parameters` will be used." } }, "id": "GoogleCloudIntegrationsV1alphaReplayExecutionRequest", "type": "object", "description": "Request for replaying an execution." }, "GoogleCloudIntegrationsV1alphaIntegrationVersion": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "description": "The integration version definition.", "properties": { "enableVariableMasking": { "type": "boolean", "description": "Optional. True if variable masking feature should be turned on for this version" }, "cloudLoggingDetails": { "description": "Optional. Cloud Logging details for the integration version", "$ref": "GoogleCloudIntegrationsV1alphaCloudLoggingDetails" }, "errorCatcherConfigs": { "description": "Optional. Error Catch Task configuration for the integration. It's optional.", "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaErrorCatcherConfig" } }, "description": { "type": "string", "description": "Optional. The integration description." }, "integrationParameters": { "description": "Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationParameter" }, "type": "array" }, "eucHardeningDisposition": { "readOnly": true, "type": "string", "enum": [ "EUC_HARDENING_DISPOSITION_UNSPECIFIED", "LEGACY", "HARDENED" ], "description": "Output only. The EUC hardening disposition of this version. Set by the service when the integration is first created and inherited unchanged by every later version, so all versions of an integration report the same value.", "enumDescriptions": [ "Not recorded: the version predates the disposition, or the integration was created before a cutover date applied to its region.", "The integration was first created before the cutover.", "The integration was first created at or after the cutover." ] }, "integrationConfigParameters": { "description": "Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.", "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" } }, "updateTime": { "description": "Output only. Auto-generated.", "type": "string", "format": "google-datetime", "readOnly": true }, "createdFromTemplate": { "type": "string", "description": "Optional. Optional. The resource name of the template from which the integration is created." }, "triggerConfigsInternal": { "deprecated": true, "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoTriggerConfig" }, "type": "array", "description": "Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations." }, "databasePersistencePolicy": { "enumDescriptions": [ "Enables persistence for all execution data.", "Disables persistence for all execution data.", "Asynchronously persist all execution data." ], "description": "Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.", "type": "string", "enum": [ "DATABASE_PERSISTENCE_POLICY_UNSPECIFIED", "DATABASE_PERSISTENCE_DISABLED", "DATABASE_PERSISTENCE_ASYNC" ] }, "integrationParametersInternal": { "$ref": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameters", "description": "Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.", "deprecated": true }, "userLabel": { "description": "Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.", "type": "string" }, "createTime": { "description": "Output only. Auto-generated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "status": { "readOnly": true, "deprecated": true, "enumDescriptions": [ "", "", "", "", "" ], "type": "string", "enum": [ "UNKNOWN", "DRAFT", "ACTIVE", "ARCHIVED", "SNAPSHOT" ], "description": "Output only. Generated by eventbus. User should not set it as an input." }, "teardown": { "description": "Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to \"finally\" in code.", "$ref": "EnterpriseCrmEventbusProtoTeardown", "deprecated": true }, "taskConfigsInternal": { "deprecated": true, "type": "array", "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoTaskConfig" }, "description": "Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs." }, "snapshotNumber": { "description": "Output only. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use \"HEAD\" tag to identify the head.", "format": "int64", "readOnly": true, "type": "string" }, "runAsServiceAccount": { "description": "Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task.", "type": "string" }, "lastModifierEmail": { "type": "string", "description": "Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call." }, "state": { "enumDescriptions": [ "Default.", "Draft.", "Active.", "Archived.", "Snapshot." ], "type": "string", "enum": [ "INTEGRATION_STATE_UNSPECIFIED", "DRAFT", "ACTIVE", "ARCHIVED", "SNAPSHOT" ], "readOnly": true, "description": "Output only. User should not set it as an input." }, "lockHolder": { "description": "Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", "type": "string" }, "cloudKmsKey": { "description": "Optional. Cloud KMS resource name for the CMEK encryption key.", "type": "string" }, "origin": { "deprecated": true, "description": "Optional. The origin that indicates where this integration is coming from.", "enumDescriptions": [ "", "Workflow is being created via event bus UI.", "User checked in this workflow in Piper as v2 textproto format and we synced it into spanner.", "User checked in this workflow in piper as v3 textproto format and we synced it into spanner.", "Workflow is being created via Standalone IP Provisioning", "Workflow is being created via Test Case." ], "enumDeprecated": [ false, false, true, false, false, false ], "type": "string", "enum": [ "UNSPECIFIED", "UI", "PIPER_V2", "PIPER_V3", "APPLICATION_IP_PROVISIONING", "TEST_CASE" ] }, "taskConfigs": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaTaskConfig" }, "description": "Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.", "type": "array" }, "name": { "type": "string", "description": "Output only. Auto-generated primary key.", "readOnly": true }, "triggerConfigs": { "type": "array", "description": "Optional. Trigger configurations.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaTriggerConfig" } }, "parentTemplateId": { "type": "string", "description": "Optional. The id of the template which was used to create this integration_version." } } }, "EnterpriseCrmEventbusProtoDoubleParameterArray": { "id": "EnterpriseCrmEventbusProtoDoubleParameterArray", "properties": { "doubleValues": { "type": "array", "items": { "type": "number", "format": "double" } } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaServiceAccountCredentials": { "type": "object", "properties": { "scope": { "description": "A space-delimited list of requested scope permissions.", "type": "string" }, "serviceAccount": { "type": "string", "description": "Name of the service account that has the permission to make the request." } }, "description": "Represents the service account which can be used to generate access token for authenticating the service call.", "id": "GoogleCloudIntegrationsV1alphaServiceAccountCredentials" }, "EnterpriseCrmEventbusProtoTransformExpression": { "properties": { "initialValue": { "description": "Initial value upon which to perform transformations.", "$ref": "EnterpriseCrmEventbusProtoBaseValue" }, "transformationFunctions": { "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoFunction" }, "description": "Transformations to be applied sequentially." } }, "id": "EnterpriseCrmEventbusProtoTransformExpression", "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoTaskEntity": { "properties": { "metadata": { "description": "Metadata inclueds the task name, author and so on.", "$ref": "EnterpriseCrmEventbusProtoTaskMetadata" }, "taskType": { "type": "string", "enum": [ "TASK", "ASIS_TEMPLATE", "IO_TEMPLATE" ], "enumDescriptions": [ "Normal IP task", "Task is of As-Is Template type", "Task is of I/O template type with a different underlying task" ], "description": "Defines the type of the task" }, "uiConfig": { "$ref": "EnterpriseCrmEventbusProtoTaskUiConfig", "description": "UI configuration for this task Also associated with the METADATA mask." }, "stats": { "description": "Deprecated - statistics from the Monarch query.", "deprecated": true, "$ref": "EnterpriseCrmEventbusStats" }, "paramSpecs": { "description": "Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.", "$ref": "EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage" }, "disabledForVpcSc": { "description": "True if the task has conflict with vpcsc", "type": "boolean" } }, "description": "Contains a task's metadata and associated information. Next available id: 7", "id": "EnterpriseCrmFrontendsEventbusProtoTaskEntity", "type": "object" }, "EnterpriseCrmEventbusProtoAddress": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string", "description": "Required." }, "tokens": { "items": { "$ref": "EnterpriseCrmEventbusProtoToken" }, "type": "array" } }, "description": "Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.", "id": "EnterpriseCrmEventbusProtoAddress" }, "GoogleCloudConnectorsV1LogConfig": { "description": "Log configuration for the connection.", "id": "GoogleCloudConnectorsV1LogConfig", "properties": { "enabled": { "description": "Optional. Enabled represents whether logging is enabled or not for a connection.", "type": "boolean" }, "level": { "description": "Optional. Log configuration level.", "type": "string", "enum": [ "LOG_LEVEL_UNSPECIFIED", "ERROR", "INFO", "DEBUG" ], "enumDescriptions": [ "Log level unspecified.", "Only error logs are enabled.", "Info and error logs are enabled.", "Debug and high verbosity logs are enabled." ] } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaTemplate": { "description": "Defines the template for Application Integration", "id": "GoogleCloudIntegrationsV1alphaTemplate", "properties": { "usageCount": { "description": "Optional. Number of template usages.", "type": "string", "format": "int64" }, "templateBundle": { "$ref": "GoogleCloudIntegrationsV1alphaTemplateBundle", "description": "Required. Bundle which is part of the templates. The template entities in the bundle would be converted to an actual entity." }, "displayName": { "type": "string", "description": "Required. The name of the template" }, "categories": { "description": "Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing.", "type": "array", "items": { "type": "string", "enum": [ "CATEGORY_UNSPECIFIED", "AI_MACHINE_LEARNING", "BUSINESS_INTELLIGENCE", "COLLABORATION", "CUSTOMER_SERVICE", "DATABASES", "DEVOPS_IT", "CONTENT_AND_FILES", "FINANCE_AND_ACCOUNTING", "HUMAN_RESOURCES", "OPERATIONS", "PRODUCT_PROJECT_MANAGEMENT", "PRODUCTIVITY", "SALES_AND_MARKETING", "UNIVERSAL_CONNECTORS", "UTILITY", "OTHERS" ], "enumDescriptions": [ "Category is unspecified", "AI_MACHINE_LEARNING", "BUSINESS_INTELLIGENCE", "COLLABORATION", "CUSTOMER_SERVICE", "DATAABASES", "DEVOPS_IT", "CONTENT_AND_FILES", "FINANCE_AND_ACCOUNTING", "HUMAN_RESOURCES", "OPERATIONS", "PRODUCT_PROJECT_MANAGEMENT", "PRODUCTIVITY", "SALES_AND_MARKETING", "UNIVERSAL_CONNECTORS", "UTILITY", "OTHERS" ] } }, "components": { "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaTemplateComponent" }, "description": "Optional. Components being used in the template. This could be used to categorize and filter." }, "sharedWith": { "items": { "type": "string" }, "description": "Required. Resource names with which the template is shared for example ProjectNumber/Ord id", "type": "array" }, "description": { "type": "string", "description": "Optional. Description of the template. The length should not be more than 255 characters" }, "lastUsedTime": { "format": "google-datetime", "type": "string", "description": "Optional. Time the template was last used." }, "createTime": { "type": "string", "description": "Output only. Auto-generated.", "format": "google-datetime", "readOnly": true }, "usageInfo": { "type": "string", "description": "Optional. Information on how to use the template. This should contain detailed information about usage of the template." }, "docLink": { "description": "Optional. Link to template documentation.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. Auto-generated", "readOnly": true, "format": "google-datetime" }, "tags": { "description": "Required. Tags which are used to identify templates. These tags could be for business use case, connectors etc.", "type": "array", "items": { "type": "string" } }, "visibility": { "enumDescriptions": [ "Visibility is unspecified", "Visibility is private", "Visibility is shared", "Visibility is public" ], "description": "Required. Visibility of the template.", "type": "string", "enum": [ "VISIBILITY_UNSPECIFIED", "PRIVATE", "SHARED", "PUBLIC" ] }, "name": { "type": "string", "description": "Identifier. Resource name of the template." }, "author": { "description": "Optional. Creator of the template.", "type": "string" } }, "type": "object" }, "EnterpriseCrmEventbusProtoCondition": { "description": "Condition that uses `operator` to evaluate the key against the value.", "id": "EnterpriseCrmEventbusProtoCondition", "properties": { "value": { "$ref": "EnterpriseCrmEventbusProtoValueType", "description": "Value that's checked for the key." }, "operator": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNSET", "EQUALS", "CONTAINS", "LESS_THAN", "GREATER_THAN", "EXISTS", "DOES_NOT_EXIST", "IS_EMPTY", "IS_NOT_EMPTY" ], "description": "Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair." }, "eventPropertyKey": { "description": "Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.", "type": "string" } }, "type": "object", "deprecated": true }, "GoogleCloudConnectorsV1AuthConfig": { "properties": { "oauth2JwtBearer": { "description": "Oauth2JwtBearer.", "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer" }, "sshPublicKey": { "description": "SSH Public Key.", "$ref": "GoogleCloudConnectorsV1AuthConfigSshPublicKey" }, "oauth2AuthCodeFlow": { "description": "Oauth2AuthCodeFlow.", "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow" }, "authType": { "enumDescriptions": [ "Authentication type not specified.", "Username and Password Authentication.", "JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication", "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", "Oauth 2.0 Authorization Code Flow", "Google authentication", "Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" ], "type": "string", "enum": [ "AUTH_TYPE_UNSPECIFIED", "USER_PASSWORD", "OAUTH2_JWT_BEARER", "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW", "GOOGLE_AUTHENTICATION", "OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" ], "description": "Optional. The type of authentication configured." }, "authKey": { "type": "string", "description": "Optional. Identifier key for auth config" }, "userPassword": { "$ref": "GoogleCloudConnectorsV1AuthConfigUserPassword", "description": "UserPassword." }, "additionalVariables": { "items": { "$ref": "GoogleCloudConnectorsV1ConfigVariable" }, "type": "array", "description": "Optional. List containing additional auth configs." }, "oauth2ClientCredentials": { "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", "description": "Oauth2ClientCredentials." }, "oauth2AuthCodeFlowGoogleManaged": { "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged", "description": "Oauth2AuthCodeFlowGoogleManaged." } }, "id": "GoogleCloudConnectorsV1AuthConfig", "type": "object", "description": "AuthConfig defines details of a authentication type." }, "GoogleCloudIntegrationsV1alphaApiTriggerResource": { "description": "List of API triggerID and their workflow resource name.", "id": "GoogleCloudIntegrationsV1alphaApiTriggerResource", "properties": { "integrationResource": { "description": "Required. Integration where the API is published", "type": "string" }, "triggerId": { "type": "array", "items": { "type": "string" }, "description": "Required. Trigger Id of the API trigger(s) in the integration" } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaGetClientMetadataResponse": { "description": "Response for the GetClientMetadata rpc", "type": "object", "id": "GoogleCloudIntegrationsV1alphaGetClientMetadataResponse", "properties": { "properties": { "$ref": "GoogleCloudIntegrationsV1alphaProjectProperties", "description": "Required. Required: The client configuration that was requested" } } }, "GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse": { "type": "object", "properties": { "executionInfoIds": { "type": "array", "items": { "type": "string" }, "description": "The execution info id for the executed integrations." } }, "description": "The response for executing an integration.", "id": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse" }, "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse": { "id": "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse", "properties": { "regions": { "items": { "type": "string" }, "description": "All regions where Connector Platform is provisioned.", "type": "array" } }, "description": "Response containing all provisioned regions for Connector Platform.", "type": "object" }, "EnterpriseCrmEventbusProtoEventExecutionDetails": { "description": "Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12", "id": "EnterpriseCrmEventbusProtoEventExecutionDetails", "properties": { "eventAttemptStats": { "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats" } }, "nextExecutionTime": { "format": "int64", "description": "Next scheduled execution time in case the execution status was RETRY_ON_HOLD.", "type": "string" }, "ryeLockUnheldCount": { "description": "Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/", "format": "int32", "type": "integer" }, "networkAddress": { "type": "string", "description": "The network address (aka. bns address) that indicates where the event executor is running." }, "eventExecutionSnapshotsSize": { "description": "Total size of all event_execution_snapshots for an execution", "type": "string", "format": "int64" }, "eventExecutionState": { "type": "string", "enum": [ "UNSPECIFIED", "ON_HOLD", "IN_PROCESS", "SUCCEEDED", "FAILED", "CANCELED", "RETRY_ON_HOLD", "SUSPENDED" ], "enumDescriptions": [ "", "Event is received and waiting for the execution. This happens when firing the event via \"postToQueue\" or \"schedule\".", "Event is under processing.", "Event execution successfully finished. There's no more change after this state.", "Event execution failed. There's no more change after this state.", "Event execution canceled by user. There's no more change after this state.", "Event execution failed and waiting for retry.", "Event execution suspended and waiting for manual intervention." ] }, "eventRetriesFromBeginningCount": { "type": "integer", "format": "int32", "description": "Indicates the number of times the execution has restarted from the beginning." }, "eventExecutionSnapshot": { "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoEventExecutionSnapshot" } }, "logFilePath": { "description": "The log file path (aka. cns address) for this event.", "type": "string" }, "cancelReason": { "type": "string", "description": "If the execution is manually canceled, this field will contain the reason for cancellation." } }, "type": "object" }, "EnterpriseCrmEventbusProtoJsonFunction": { "properties": { "functionName": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNSPECIFIED", "GET_PROPERTY", "GET_ELEMENT", "APPEND_ELEMENT", "SIZE", "SET_PROPERTY", "FLATTEN", "FLATTEN_ONCE", "MERGE", "TO_STRING", "TO_INT", "TO_DOUBLE", "TO_BOOLEAN", "TO_PROTO", "TO_STRING_ARRAY", "TO_INT_ARRAY", "TO_DOUBLE_ARRAY", "TO_PROTO_ARRAY", "TO_BOOLEAN_ARRAY", "REMOVE_PROPERTY", "RESOLVE_TEMPLATE", "EQUALS", "FOR_EACH", "FILTER_ELEMENTS" ] } }, "id": "EnterpriseCrmEventbusProtoJsonFunction", "type": "object" }, "GoogleCloudIntegrationsV1alphaCustomerConfig": { "id": "GoogleCloudIntegrationsV1alphaCustomerConfig", "description": "Customer configuration information for the given client", "type": "object", "properties": { "runAsServiceAccount": { "type": "string", "description": "Optional. Run-as service account to be updated for the provisioned client." }, "enableVariableMasking": { "description": "Optional. True if variable masking feature should be turned on for this region.", "type": "boolean" }, "enableHttpCall": { "type": "boolean", "description": "Optional. Indicates if the client should be allowed to make HTTP calls. True if http call feature should be turned on for this region." }, "enableManagedAiFeatures": { "type": "boolean", "description": "Optional. Indicates if the client should be allowed to use managed AI features, i.e. using Cloud Companion APIs of the tenant project. This will allow the customers to use features like Troubleshooting, OpenAPI spec enrichment, etc. for free." }, "cloudKmsConfig": { "description": "Optional. Cloud KMS config for Auth Module to encrypt/decrypt credentials.", "$ref": "GoogleCloudIntegrationsV1alphaCloudKmsConfig" }, "enableEucHardenedFlow": { "type": "boolean", "description": "Optional. True if every integration in this region should run under the hardened end-user-credential flow. See go/ip-euc-harden." } } }, "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo": { "properties": { "snapshotNumber": { "description": "Workflow snapshot number.", "type": "string", "format": "int64" }, "workflowId": { "type": "string", "description": "Required. Pointer to the workflow it is executing." }, "workflowName": { "description": "Name of the workflow.", "type": "string" }, "workflowRetryBackoffIntervalSeconds": { "type": "string", "format": "int64", "description": "Time interval in seconds to schedule retry of workflow in manifold when workflow is already running" }, "responseParams": { "description": "Event parameters come out as part of the response.", "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters" }, "errorCode": { "$ref": "CrmlogErrorCode", "description": "Final error-code if event failed." }, "requestId": { "description": "Optional. This is used to de-dup incoming request.", "type": "string" }, "tenant": { "type": "string", "description": "Tenant this event is created. Used to reschedule the event to correct tenant." }, "integrationVersionUserLabel": { "type": "string", "description": "User-defined label that annotates the executed integration version." }, "clientId": { "type": "string", "description": "The event data user sends as request." }, "cloudLoggingDetails": { "$ref": "EnterpriseCrmEventbusProtoCloudLoggingDetails", "description": "Cloud Logging details for execution info" }, "requestParams": { "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "description": "Event parameters come in as part of the request." }, "errors": { "type": "array", "description": "Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained.", "items": { "$ref": "EnterpriseCrmEventbusProtoErrorDetail" } }, "postMethod": { "description": "The ways user posts this event.", "type": "string", "enum": [ "UNSPECIFIED", "POST", "POST_TO_QUEUE", "SCHEDULE", "POST_BY_EVENT_CONFIG_ID", "POST_WITH_EVENT_DETAILS" ], "enumDescriptions": [ "", "", "", "", "", "" ] }, "eventExecutionDetails": { "description": "The execution info about this event.", "$ref": "EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails" }, "createTime": { "description": "Auto-generated.", "type": "string", "format": "int64" }, "replayInfo": { "$ref": "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfoReplayInfo", "description": "Replay info for the execution" }, "eventExecutionInfoId": { "description": "Auto-generated primary key.", "type": "string" }, "lastModifiedTime": { "description": "Auto-generated.", "format": "int64", "type": "string" }, "executionTraceInfo": { "$ref": "EnterpriseCrmEventbusProtoExecutionTraceInfo", "description": "Execution trace info to aggregate parent-child executions." }, "product": { "enumDescriptions": [ "", "", "", "" ], "type": "string", "enum": [ "UNSPECIFIED_PRODUCT", "IP", "APIGEE", "SECURITY" ], "description": "Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default." }, "triggerId": { "description": "The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.", "type": "string" } }, "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo", "type": "object", "description": "Contains all the execution details for a workflow instance. Next available id: 27" }, "EnterpriseCrmEventbusProtoFunction": { "id": "EnterpriseCrmEventbusProtoFunction", "type": "object", "properties": { "functionType": { "description": "The name of the function to perform.", "$ref": "EnterpriseCrmEventbusProtoFunctionType" }, "parameters": { "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoTransformExpression" }, "description": "List of parameters required for the transformation." } } }, "GoogleCloudIntegrationsV1alphaDeprovisionClientRequest": { "properties": {}, "description": "Request for the Deprovision rpc", "id": "GoogleCloudIntegrationsV1alphaDeprovisionClientRequest", "type": "object" }, "GoogleCloudConnectorsV1AdminFilters": { "description": "* AdminFilters defines a set of filters that can be applied to a connection. These are currently used by Gemini Enterprise connections.", "id": "GoogleCloudConnectorsV1AdminFilters", "type": "object", "properties": { "stringListValues": { "$ref": "GoogleCloudConnectorsV1AdminFiltersStringListValues", "description": "Optional. List of string values." }, "filterKey": { "type": "string", "description": "Required. Unique name for the filter, e.g., \"SharePointSiteURL\", \"DocumentType\", \"ChatSpaceName\"." }, "stringValue": { "description": "Optional. A single string value.", "type": "string" }, "intValue": { "format": "int64", "type": "string", "description": "Optional. A single integer value." }, "filterType": { "enumDescriptions": [ "Filter type is not specified.", "Only allow items matching the configured values.", "Disallow items matching the configured values." ], "type": "string", "enum": [ "FILTER_TYPE_UNSPECIFIED", "INCLUSION", "EXCLUSION" ], "description": "Required. Type of the filter." } } }, "GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse": { "type": "object", "description": "Response for DownloadTestCase.", "properties": { "content": { "description": "String representation of the test case.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse" }, "GoogleCloudIntegrationsV1alphaUploadTestCaseResponse": { "type": "object", "description": "Response for UploadTestCase.", "properties": { "testCase": { "description": "The uploaded TestCase", "$ref": "GoogleCloudIntegrationsV1alphaTestCase" } }, "id": "GoogleCloudIntegrationsV1alphaUploadTestCaseResponse" }, "GoogleCloudIntegrationsV1alphaAuthConfig": { "properties": { "createTime": { "readOnly": true, "description": "Output only. The timestamp when the auth config is created.", "type": "string", "format": "google-datetime" }, "expiryNotificationDuration": { "items": { "type": "string", "format": "google-duration" }, "type": "array", "description": "Optional. User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours." }, "displayName": { "description": "Required. The name of the auth config.", "type": "string" }, "encryptedCredential": { "format": "byte", "description": "Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.", "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "VALID", "INVALID", "SOFT_DELETED", "EXPIRED", "UNAUTHORIZED", "UNSUPPORTED" ], "description": "Output only. The status of the auth config.", "enumDescriptions": [ "Status not specified.", "Valid Auth config.", "General invalidity, if it doesn't fits in the detailed issue below.", "Auth config soft deleted.", "Auth config expired.", "Auth config unauthorized.", "Auth config not supported." ], "readOnly": true }, "overrideValidTime": { "format": "google-datetime", "type": "string", "description": "Optional. User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings." }, "lastModifierEmail": { "type": "string", "description": "The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call." }, "name": { "description": "Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.", "type": "string" }, "creatorEmail": { "description": "The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", "type": "string" }, "updateTime": { "type": "string", "description": "Output only. The timestamp when the auth config is modified.", "format": "google-datetime", "readOnly": true }, "visibility": { "type": "string", "enum": [ "AUTH_CONFIG_VISIBILITY_UNSPECIFIED", "PRIVATE", "CLIENT_VISIBLE" ], "enumDescriptions": [ "Visibility not specified.", "Profile visible to the creator only.", "Profile visible within the client." ], "description": "Optional. The visibility of the auth config." }, "description": { "type": "string", "description": "Optional. A description of the auth config." }, "certificateId": { "description": "Certificate id for client certificate", "type": "string" }, "credentialType": { "type": "string", "enum": [ "CREDENTIAL_TYPE_UNSPECIFIED", "USERNAME_AND_PASSWORD", "API_KEY", "OAUTH2_AUTHORIZATION_CODE", "OAUTH2_IMPLICIT", "OAUTH2_CLIENT_CREDENTIALS", "OAUTH2_RESOURCE_OWNER_CREDENTIALS", "JWT", "AUTH_TOKEN", "SERVICE_ACCOUNT", "CLIENT_CERTIFICATE_ONLY", "OIDC_TOKEN" ], "description": "Required. Credential type of the encrypted credential.", "enumDescriptions": [ "Unspecified credential type", "Regular username/password pair.", "API key.", "OAuth 2.0 Authorization Code Grant Type.", "OAuth 2.0 Implicit Grant Type.", "OAuth 2.0 Client Credentials Grant Type.", "OAuth 2.0 Resource Owner Credentials Grant Type.", "JWT Token.", "Auth Token, e.g. bearer token.", "Service Account which can be used to generate token for authentication.", "Client Certificate only.", "Google OIDC ID Token" ] }, "reason": { "readOnly": true, "description": "Output only. The reason / details of the current status.", "type": "string" }, "validTime": { "format": "google-datetime", "description": "Optional. The time until the auth config is valid. Empty or max value is considered the auth config won't expire.", "type": "string" }, "decryptedCredential": { "$ref": "GoogleCloudIntegrationsV1alphaCredential", "description": "Raw auth credentials." } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaAuthConfig", "description": "The AuthConfig resource use to hold channels and connection config data." }, "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow": { "description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.", "id": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow", "properties": { "authUri": { "type": "string", "description": "Optional. Auth URL for Authorization Code Flow" }, "clientSecret": { "$ref": "GoogleCloudConnectorsV1Secret", "description": "Optional. Client secret for user-provided OAuth app." }, "clientId": { "type": "string", "description": "Optional. Client ID for user-provided OAuth app." }, "scopes": { "description": "Optional. Scopes the connection will request when the user performs the auth code flow.", "items": { "type": "string" }, "type": "array" }, "enablePkce": { "type": "boolean", "description": "Optional. Whether to enable PKCE when the user performs the auth code flow." }, "authCode": { "type": "string", "description": "Optional. Authorization code to be exchanged for access and refresh tokens." }, "pkceVerifier": { "description": "Optional. PKCE verifier to be used during the auth code exchange.", "type": "string" }, "redirectUri": { "description": "Optional. Redirect URI to be provided during the auth code exchange.", "type": "string" } }, "type": "object" }, "EnterpriseCrmEventbusProtoSerializedObjectParameter": { "id": "EnterpriseCrmEventbusProtoSerializedObjectParameter", "type": "object", "properties": { "objectValue": { "format": "byte", "type": "string" } } }, "EnterpriseCrmEventbusProtoParamSpecEntryConfig": { "id": "EnterpriseCrmEventbusProtoParamSpecEntryConfig", "type": "object", "properties": { "label": { "description": "A user-friendly label for the parameter.", "type": "string" }, "descriptivePhrase": { "description": "A short phrase to describe what this parameter contains.", "type": "string" }, "subSectionLabel": { "description": "A user-friendly label for subSection under which the parameter will be displayed.", "type": "string" }, "inputDisplayOption": { "type": "string", "enum": [ "DEFAULT", "STRING_MULTI_LINE", "NUMBER_SLIDER", "BOOLEAN_TOGGLE" ], "enumDescriptions": [ "A single-line input for strings, a numeric input box for numbers, or a checkbox for booleans.", "A multi-line input box for longer strings/string templates.", "A slider to select a numerical value. The default range is [0, 100].", "A toggle button for boolean parameters." ] }, "uiPlaceholderText": { "type": "string", "description": "Placeholder text which will appear in the UI input form for this parameter." }, "parameterNameOption": { "enumDescriptions": [ "This field is not a parameter name.", "If this field is a string and this option is selected, the field will be interpreted as a parameter name. Users will be able to choose a variable using the autocomplete, but the name will be stored as a literal string.", "If this field is a ParameterMap and this option is selected, the map's keys will be interpreted as parameter names. Ignored if this field is not a ParameterMap.", "If this field is a ParameterMap and this option is selected, the map's values will be interpreted as parameter names. Ignored if this field is not a ParameterMap." ], "type": "string", "enum": [ "DEFAULT_NOT_PARAMETER_NAME", "IS_PARAMETER_NAME", "KEY_IS_PARAMETER_NAME", "VALUE_IS_PARAMETER_NAME" ] }, "isHidden": { "description": "Whether this field is hidden in the UI.", "type": "boolean" }, "hideDefaultValue": { "description": "Whether the default value is hidden in the UI.", "type": "boolean" }, "helpText": { "description": "Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.", "type": "string" } } }, "EnterpriseCrmEventbusProtoParameterEntry": { "description": "Key-value pair of EventBus parameters.", "id": "EnterpriseCrmEventbusProtoParameterEntry", "type": "object", "properties": { "masked": { "type": "boolean", "description": "True if this parameter should be masked in the logs" }, "key": { "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.", "type": "string" }, "value": { "$ref": "EnterpriseCrmEventbusProtoParameterValueType", "description": "Values for the defined keys. Each value can either be string, int, double or any proto message." } } }, "GoogleCloudIntegrationsV1alphaListCertificatesResponse": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaListCertificatesResponse", "description": "Response to list Certificates.", "properties": { "nextPageToken": { "type": "string", "description": "The token used to retrieve the next page of results." }, "certificates": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "description": "The list of Certificates retrieved.", "type": "array" } } }, "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex": { "properties": { "regex": { "type": "string", "description": "The regex applied to the input value(s)." }, "exclusive": { "description": "Whether the regex matcher is applied exclusively (if true, matching values will be rejected).", "type": "boolean" } }, "type": "object", "description": "Rule used to validate strings.", "id": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleStringRegex" }, "EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata": { "properties": { "taskNumber": { "description": "The task number associated with this snapshot. Could be empty.", "type": "string" }, "eventAttemptNum": { "type": "integer", "description": "the event attempt number this snapshot belongs to.", "format": "int32" }, "integrationName": { "type": "string", "description": "The direct integration which the event execution snapshots belongs to" }, "taskLabel": { "type": "string", "description": "the task label associated with this snapshot. Could be empty." }, "ancestorTaskNumbers": { "items": { "type": "string" }, "description": "Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow')", "type": "array" }, "ancestorIterationNumbers": { "type": "array", "description": "Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow')", "items": { "type": "string" } }, "taskAttemptNum": { "description": "the task attempt number this snapshot belongs to. Could be empty.", "format": "int32", "type": "integer" }, "taskName": { "type": "string", "description": "the task name associated with this snapshot. Could be empty." } }, "id": "EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata", "type": "object" }, "EnterpriseCrmEventbusProtoFunctionType": { "type": "object", "id": "EnterpriseCrmEventbusProtoFunctionType", "properties": { "protoArrayFunction": { "$ref": "EnterpriseCrmEventbusProtoProtoArrayFunction" }, "booleanArrayFunction": { "$ref": "EnterpriseCrmEventbusProtoBooleanArrayFunction" }, "baseFunction": { "description": "LINT.IfChange", "$ref": "EnterpriseCrmEventbusProtoBaseFunction" }, "doubleArrayFunction": { "$ref": "EnterpriseCrmEventbusProtoDoubleArrayFunction" }, "booleanFunction": { "$ref": "EnterpriseCrmEventbusProtoBooleanFunction" }, "protoFunction": { "$ref": "EnterpriseCrmEventbusProtoProtoFunction" }, "stringFunction": { "$ref": "EnterpriseCrmEventbusProtoStringFunction" }, "jsonFunction": { "$ref": "EnterpriseCrmEventbusProtoJsonFunction" }, "intArrayFunction": { "$ref": "EnterpriseCrmEventbusProtoIntArrayFunction" }, "intFunction": { "$ref": "EnterpriseCrmEventbusProtoIntFunction" }, "doubleFunction": { "$ref": "EnterpriseCrmEventbusProtoDoubleFunction" }, "stringArrayFunction": { "$ref": "EnterpriseCrmEventbusProtoStringArrayFunction" } } }, "EnterpriseCrmEventbusProtoNextTask": { "properties": { "combinedConditions": { "description": "Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`", "type": "array", "deprecated": true, "items": { "$ref": "EnterpriseCrmEventbusProtoCombinedCondition" } }, "label": { "description": "User-provided label that is attached to this edge in the UI.", "type": "string" }, "taskNumber": { "description": "Task number of the next task.", "type": "string" }, "taskConfigId": { "description": "ID of the next task.", "type": "string" }, "condition": { "description": "Standard filter expression for this task to become an eligible next task.", "type": "string" }, "description": { "type": "string", "description": "User-provided description intended to give more business context about the next task edge or condition." } }, "description": "The task that is next in line to be executed, if the condition specified evaluated to true.", "type": "object", "id": "EnterpriseCrmEventbusProtoNextTask" }, "EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray": { "properties": { "booleanValues": { "items": { "type": "boolean" }, "type": "array" } }, "type": "object", "id": "EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray" }, "GoogleProtobufEmpty": { "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", "id": "GoogleProtobufEmpty", "properties": {} }, "GoogleCloudIntegrationsV1alphaCertificate": { "description": "The certificate definition", "id": "GoogleCloudIntegrationsV1alphaCertificate", "type": "object", "properties": { "rawCertificate": { "description": "Input only. Raw client certificate which would be registered with trawler", "$ref": "GoogleCloudIntegrationsV1alphaClientCertificate" }, "credentialId": { "description": "Immutable. Credential id that will be used to register with trawler", "type": "string" }, "displayName": { "description": "Required. Name of the certificate", "type": "string" }, "name": { "type": "string", "description": "Output only. Auto generated primary key", "readOnly": true }, "requestorId": { "type": "string", "description": "Immutable. Requestor ID to be used to register certificate with trawler" }, "validEndTime": { "description": "Output only. The timestamp after which certificate will expire", "type": "string", "format": "google-datetime", "readOnly": true }, "certificateStatus": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "EXPIRED" ], "enumDescriptions": [ "Unspecified certificate status", "Certificate in active state will be able to use", "Certificate in expired state needs to be updated" ], "description": "Status of the certificate" }, "description": { "type": "string", "description": "Description of the certificate" }, "validStartTime": { "readOnly": true, "description": "Output only. The timestamp after which certificate will be valid", "type": "string", "format": "google-datetime" } } }, "EnterpriseCrmEventbusProtoParameterMapField": { "type": "object", "id": "EnterpriseCrmEventbusProtoParameterMapField", "description": "Field represents either the key or value in an entry.", "properties": { "referenceKey": { "type": "string", "description": "Referencing one of the WF variables." }, "literalValue": { "$ref": "EnterpriseCrmEventbusProtoParameterValueType", "description": "Passing a literal value." } } }, "GoogleCloudIntegrationsV1alphaLiftSuspensionResponse": { "id": "GoogleCloudIntegrationsV1alphaLiftSuspensionResponse", "properties": { "eventExecutionInfoId": { "description": "Execution Id that will be returned", "type": "string" } }, "type": "object", "description": "Response of lift Suspense" }, "GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest": { "type": "object", "description": "Request for Creating Cloud Function rpc call.", "id": "GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest", "properties": { "projectId": { "type": "string", "description": "Indicates the id of the GCP project that the function will be created in." }, "functionRegion": { "type": "string", "description": "The function region of CF to be created" }, "gcfApiVersion": { "enumDescriptions": [ "Unspecified.", "V1 API version.", "V2 API version." ], "description": "Optional. The api version of CF to be created", "type": "string", "enum": [ "GCF_API_VERSION_UNSPECIFIED", "API_VERSION_V1", "API_VERSION_V2" ] }, "functionName": { "description": "The function name of CF to be created", "type": "string" } } }, "EnterpriseCrmEventbusProtoBooleanFunction": { "type": "object", "properties": { "functionName": { "type": "string", "enum": [ "UNSPECIFIED", "TO_JSON", "NOT", "AND", "NAND", "OR", "XOR", "NOR", "XNOR", "TO_STRING", "EQUALS" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "" ] } }, "id": "EnterpriseCrmEventbusProtoBooleanFunction" }, "EnterpriseCrmEventbusProtoProtoFunction": { "type": "object", "properties": { "functionName": { "type": "string", "enum": [ "UNSPECIFIED", "GET_STRING_SUBFIELD", "GET_INT_SUBFIELD", "GET_DOUBLE_SUBFIELD", "GET_BOOLEAN_SUBFIELD", "GET_STRING_ARRAY_SUBFIELD", "GET_INT_ARRAY_SUBFIELD", "GET_DOUBLE_ARRAY_SUBFIELD", "GET_BOOLEAN_ARRAY_SUBFIELD", "GET_PROTO_ARRAY_SUBFIELD", "GET_PROTO_SUBFIELD", "TO_JSON", "GET_BYTES_SUBFIELD_AS_UTF_8_STRING", "GET_BYTES_SUBFIELD_AS_PROTO", "EQUALS" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ] } }, "id": "EnterpriseCrmEventbusProtoProtoFunction" }, "EnterpriseCrmEventbusProtoNextTeardownTask": { "properties": { "name": { "description": "Required. Name of the next teardown task.", "type": "string" } }, "type": "object", "description": "The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).", "id": "EnterpriseCrmEventbusProtoNextTeardownTask" }, "EnterpriseCrmEventbusProtoParameterMapEntry": { "type": "object", "description": "Entry is a pair of key and value.", "id": "EnterpriseCrmEventbusProtoParameterMapEntry", "properties": { "key": { "$ref": "EnterpriseCrmEventbusProtoParameterMapField" }, "value": { "$ref": "EnterpriseCrmEventbusProtoParameterMapField" } } }, "GoogleCloudIntegrationsV1alphaConditionalFailurePolicies": { "id": "GoogleCloudIntegrationsV1alphaConditionalFailurePolicies", "description": "Conditional task failur retry strategies", "type": "object", "properties": { "defaultFailurePolicy": { "$ref": "GoogleCloudIntegrationsV1alphaFailurePolicy", "description": "The default failure policy to be applied if no conditional failure policy matches." }, "failurePolicies": { "description": "The list of failure policies that will be applied to the task in order.", "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaFailurePolicy" } } } }, "EnterpriseCrmEventbusProtoLogSettings": { "properties": { "seedScope": { "enumDescriptions": [ "", "Hash computations include the event name.", "Hash computations include a time period.", "Hash computations include the param name." ], "type": "string", "enum": [ "SEED_SCOPE_UNSPECIFIED", "EVENT_NAME", "TIME_PERIOD", "PARAM_NAME" ] }, "logFieldName": { "description": "The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.", "type": "string" }, "seedPeriod": { "type": "string", "enum": [ "SEED_PERIOD_UNSPECIFIED", "DAY", "WEEK", "MONTH" ], "enumDescriptions": [ "", "Sanitized values remain constant for the day of the event.", "Sanitized values remain constant for the week of the event; may cross month boundaries.", "Sanitized values remain constant for the month of the event." ] } }, "id": "EnterpriseCrmEventbusProtoLogSettings", "type": "object", "description": "The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information." }, "GoogleCloudIntegrationsV1alphaProvisionClientRequest": { "description": "Request for the Provision rpc", "type": "object", "properties": { "runAsServiceAccount": { "description": "Optional. User input run-as service account, if empty, will bring up a new default service account", "type": "string" }, "enableHttpCall": { "description": "Optional. Indicates if the client should be allowed to make HTTP calls.", "type": "boolean" }, "enableManagedAiFeatures": { "type": "boolean", "description": "Optional. Indicates if the client should be allowed to use managed AI features, i.e. using Cloud Companion APIs of the tenant project. This will allow the customers to use features like Troubleshooting, OpenAPI spec enrichment, etc. for free." }, "createSampleWorkflows": { "type": "boolean", "description": "Optional. Indicates if sample workflow should be created along with provisioning" }, "provisionGmek": { "deprecated": true, "description": "Optional. Deprecated. Indicates provision with GMEK or CMEK. This field is deprecated and the provision would always be GMEK if cloud_kms_config is not present in the request.", "type": "boolean" }, "cloudKmsConfig": { "description": "Optional. OPTIONAL: Cloud KMS config for AuthModule to encrypt/decrypt credentials.", "$ref": "GoogleCloudIntegrationsV1alphaCloudKmsConfig" }, "skipCpProvision": { "type": "boolean", "description": "Optional. Indicates if skip CP provision or not" } }, "id": "GoogleCloudIntegrationsV1alphaProvisionClientRequest" }, "EnterpriseCrmEventbusProtoProtoParameterArray": { "properties": { "protoValues": { "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" }, "type": "array" } }, "id": "EnterpriseCrmEventbusProtoProtoParameterArray", "type": "object" }, "GoogleCloudIntegrationsV1alphaUploadTestCaseRequest": { "properties": { "content": { "description": "The textproto of the test case.", "type": "string" }, "fileFormat": { "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "description": "File format for upload request.", "enumDescriptions": [ "Unspecified file format", "JSON File Format", "YAML File Format" ] } }, "id": "GoogleCloudIntegrationsV1alphaUploadTestCaseRequest", "type": "object", "description": "Request for UploadTestCase." }, "GoogleCloudConnectorsV1TrafficShapingConfig": { "id": "GoogleCloudConnectorsV1TrafficShapingConfig", "properties": { "duration": { "format": "google-duration", "type": "string", "description": "Required. Specifies the duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds." }, "quotaLimit": { "description": "Required. Maximum number of api calls allowed.", "type": "string", "format": "int64" } }, "type": "object", "description": "* TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on." }, "GoogleCloudIntegrationsV1alphaRuntimeActionSchema": { "id": "GoogleCloudIntegrationsV1alphaRuntimeActionSchema", "type": "object", "description": "Metadata of an action, including schemas for its inputs and outputs.", "properties": { "action": { "type": "string", "description": "Name of the action." }, "outputSchema": { "description": "Output parameter schema for the action.", "type": "string" }, "inputSchema": { "description": "Input parameter schema for the action.", "type": "string" } } }, "EnterpriseCrmEventbusStatsDimensions": { "type": "object", "id": "EnterpriseCrmEventbusStatsDimensions", "properties": { "retryAttempt": { "type": "string", "enum": [ "UNSPECIFIED", "FINAL", "RETRYABLE", "CANCELED" ], "enumDescriptions": [ "", "Task has completed successfully or has depleted all retry attempts.", "Task has failed but may be retried.", "Task has been deliberately canceled." ] }, "errorEnumString": { "type": "string" }, "enumFilterType": { "enumDescriptions": [ "", "" ], "description": "Whether to include or exclude the enums matching the regex.", "type": "string", "enum": [ "DEFAULT_INCLUSIVE", "EXCLUSIVE" ] }, "triggerId": { "description": "Stats have been or will be aggregated on set fields for any semantically-meaningful combination.", "type": "string" }, "taskNumber": { "type": "string" }, "taskName": { "type": "string" }, "warningEnumString": { "type": "string" }, "workflowName": { "type": "string" }, "clientId": { "type": "string" }, "workflowId": { "type": "string" } } }, "GoogleCloudIntegrationsV1alphaToggleHttpRequest": { "properties": { "enableHttpCall": { "description": "Required. REQUIRED: True if http call feature should be turned on for this region", "type": "boolean" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaToggleHttpRequest", "description": "Request to enable/disable http call for a provisioned client" }, "GoogleCloudConnectorsV1ConfigVariable": { "properties": { "encryptionKeyValue": { "$ref": "GoogleCloudConnectorsV1EncryptionKey", "description": "Optional. Value is a Encryption Key." }, "key": { "description": "Optional. Key of the config variable.", "type": "string" }, "secretValue": { "description": "Optional. Value is a secret.", "$ref": "GoogleCloudConnectorsV1Secret" }, "stringValue": { "description": "Optional. Value is a string.", "type": "string" }, "boolValue": { "description": "Optional. Value is a bool.", "type": "boolean" }, "intValue": { "type": "string", "format": "int64", "description": "Optional. Value is an integer" } }, "description": "ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.", "type": "object", "id": "GoogleCloudConnectorsV1ConfigVariable" }, "EnterpriseCrmEventbusProtoErrorDetail": { "type": "object", "properties": { "severity": { "description": "The severity of the error: ERROR|WARN|INFO.", "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "ERROR", "WARN", "INFO" ], "enumDescriptions": [ "", "", "", "" ] }, "errorMessage": { "type": "string", "description": "The full text of the error message, including any parameters that were thrown along with the exception." }, "errorCode": { "description": "The associated error-code, which can be a common or internal code.", "$ref": "CrmlogErrorCode" }, "taskNumber": { "type": "integer", "description": "The task try-number, in which, the error occurred. If zero, the error happened at the event level.", "format": "int32" } }, "id": "EnterpriseCrmEventbusProtoErrorDetail", "description": "An error, warning, or information message associated with a workflow." }, "EnterpriseCrmEventbusProtoPropertyEntry": { "id": "EnterpriseCrmEventbusProtoPropertyEntry", "description": "Key-value pair of EventBus property.", "properties": { "value": { "description": "Values for the defined keys. Each value can either be string, int, double or any proto message.", "$ref": "EnterpriseCrmEventbusProtoValueType" }, "key": { "description": "Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.", "type": "string" } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaIntegrationParameter": { "type": "object", "description": "Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.", "properties": { "masked": { "description": "True if this parameter should be masked in the logs", "type": "boolean" }, "defaultValue": { "$ref": "GoogleCloudIntegrationsV1alphaValueType", "description": "Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." }, "description": { "description": "Optional. Description of the parameter.", "type": "string" }, "jsonSchema": { "description": "This schema will be used to validate runtime JSON-typed values of this parameter.", "type": "string" }, "isTransient": { "description": "Whether this parameter is a transient parameter.", "type": "boolean" }, "producer": { "description": "The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.", "type": "string" }, "key": { "type": "string", "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition." }, "searchable": { "type": "boolean", "description": "Searchable in the execution log or not." }, "containsLargeData": { "type": "boolean", "description": "Indicates whether this variable contains large data and need to be uploaded to Cloud Storage." }, "dataType": { "description": "Type of the parameter.", "type": "string", "enum": [ "INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "BOOLEAN_ARRAY", "JSON_VALUE", "PROTO_VALUE", "PROTO_ARRAY", "NON_SERIALIZABLE_OBJECT", "PROTO_ENUM", "SERIALIZED_OBJECT_VALUE", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY" ], "enumDescriptions": [ "Unspecified.", "String.", "Integer.", "Double Number.", "Boolean.", "String Array.", "Integer Array.", "Double Number Array.", "Boolean Array.", "Json.", "Proto Value (Internal use only).", "Proto Array (Internal use only).", "// Non-serializable object (Internal use only).", "Proto Enum (Internal use only).", "Serialized object (Internal use only).", "Proto Enum Array (Internal use only).", "BYTES data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields." ] }, "inputOutputType": { "type": "string", "enum": [ "IN_OUT_TYPE_UNSPECIFIED", "IN", "OUT", "IN_OUT" ], "description": "Specifies the input/output type for the parameter.", "enumDescriptions": [ "Default.", "Input parameters for the integration. EventBus validates that these parameters exist in the integrations before execution.", "Output Parameters for the integration. EventBus will only return the integration parameters tagged with OUT in the response back.", "Input and Output Parameters. These can be used as both input and output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response." ] }, "displayName": { "type": "string", "description": "The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is \"foo.bar.myName\", then the name would be \"myName\"." } }, "id": "GoogleCloudIntegrationsV1alphaIntegrationParameter" }, "GoogleCloudIntegrationsV1alphaOidcToken": { "id": "GoogleCloudIntegrationsV1alphaOidcToken", "properties": { "audience": { "description": "Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.", "type": "string" }, "serviceAccountEmail": { "description": "The service account email to be used as the identity for the token.", "type": "string" }, "token": { "description": "ID token obtained for the service account", "type": "string" }, "tokenExpireTime": { "type": "string", "format": "google-datetime", "description": "The approximate time until the token retrieved is valid." } }, "description": "OIDC Token", "type": "object" }, "GoogleCloudIntegrationsV1alphaStringParameterArray": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaStringParameterArray", "description": "This message only contains a field of string array.", "properties": { "stringValues": { "items": { "type": "string" }, "description": "String array.", "type": "array" } } }, "GoogleCloudIntegrationsV1alphaCredential": { "id": "GoogleCloudIntegrationsV1alphaCredential", "description": "Defines parameters for a single, canonical credential.", "properties": { "usernameAndPassword": { "$ref": "GoogleCloudIntegrationsV1alphaUsernameAndPassword", "description": "Username and password credential" }, "oauth2AuthorizationCode": { "description": "The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential", "$ref": "GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode" }, "jwt": { "$ref": "GoogleCloudIntegrationsV1alphaJwt", "description": "JWT credential" }, "serviceAccountCredentials": { "$ref": "GoogleCloudIntegrationsV1alphaServiceAccountCredentials", "description": "Service account credential" }, "oauth2ResourceOwnerCredentials": { "description": "OAuth2 resource owner credentials", "$ref": "GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials" }, "oidcToken": { "description": "Google OIDC ID Token", "$ref": "GoogleCloudIntegrationsV1alphaOidcToken" }, "authToken": { "description": "Auth token credential", "$ref": "GoogleCloudIntegrationsV1alphaAuthToken" }, "credentialType": { "enumDescriptions": [ "Unspecified credential type", "Regular username/password pair.", "API key.", "OAuth 2.0 Authorization Code Grant Type.", "OAuth 2.0 Implicit Grant Type.", "OAuth 2.0 Client Credentials Grant Type.", "OAuth 2.0 Resource Owner Credentials Grant Type.", "JWT Token.", "Auth Token, e.g. bearer token.", "Service Account which can be used to generate token for authentication.", "Client Certificate only.", "Google OIDC ID Token" ], "description": "Credential type associated with auth config.", "type": "string", "enum": [ "CREDENTIAL_TYPE_UNSPECIFIED", "USERNAME_AND_PASSWORD", "API_KEY", "OAUTH2_AUTHORIZATION_CODE", "OAUTH2_IMPLICIT", "OAUTH2_CLIENT_CREDENTIALS", "OAUTH2_RESOURCE_OWNER_CREDENTIALS", "JWT", "AUTH_TOKEN", "SERVICE_ACCOUNT", "CLIENT_CERTIFICATE_ONLY", "OIDC_TOKEN" ] }, "oauth2ClientCredentials": { "$ref": "GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials", "description": "OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials" } }, "type": "object" }, "GoogleCloudConnectorsV1AuthConfigSshPublicKey": { "properties": { "sshClientCertPass": { "$ref": "GoogleCloudConnectorsV1Secret", "description": "Optional. Password (passphrase) for ssh client certificate if it has one." }, "username": { "description": "Optional. The user account used to authenticate.", "type": "string" }, "sshClientCert": { "description": "Optional. SSH Client Cert. It should contain both public and private key.", "$ref": "GoogleCloudConnectorsV1Secret" }, "certType": { "type": "string", "description": "Optional. Format of SSH Client cert." } }, "description": "Parameters to support Ssh public key Authentication.", "id": "GoogleCloudConnectorsV1AuthConfigSshPublicKey", "type": "object" }, "GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration": { "type": "object", "properties": { "liftWhenExpired": { "description": "Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.", "type": "boolean" }, "expireTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Time after which the suspension expires, if no action taken." }, "remindTime": { "format": "google-datetime", "description": "Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.", "type": "string" } }, "description": "Expiration configs for the approval request.", "id": "GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration" }, "GoogleCloudIntegrationsV1alphaProjectProperties": { "description": "Metadata information for the given project", "type": "object", "properties": { "billingType": { "type": "string", "enum": [ "BILLING_TYPE_UNSPECIFIED", "APIGEE_TRIALS", "APIGEE_SUBSCRIPTION", "PAYG", "SUBSCRIPTION", "NO_BILLING" ], "description": "Required. Required: The client billing type that was requested", "enumDescriptions": [ "", "A trial org provisioned through Apigee Provisioning Wizard", "Subscription based on concurrency model for Apigee and Application Integration users.", "Consumption based users of IP", "Argentum subscription for Application Integration users. To be used in the future.", "Special billing type to avoid any billing to clients (eg: trusted tester program). This should not be used without consulting with the leads." ] }, "ipEnablementState": { "enumDescriptions": [ "The client enablement status is unspecified", "The client is enabled on Standalone IP", "The client is enabled on Apigee", "The client is entitled for Apigee but not enabled" ], "type": "string", "enum": [ "IP_ENABLEMENT_STATE_UNSPECIFIED", "IP_ENABLEMENT_STATE_STANDALONE", "IP_ENABLEMENT_STATE_APIGEE", "IP_ENABLEMENT_STATE_APIGEE_ENTITLED" ], "description": "An enum value of what the enablement state is for the given project" }, "provisionedRegions": { "type": "array", "description": "A list of provisioned regions on the current project", "items": { "type": "string" } } }, "id": "GoogleCloudIntegrationsV1alphaProjectProperties" }, "GoogleCloudIntegrationsV1alphaValueType": { "description": "The type of the parameter.", "id": "GoogleCloudIntegrationsV1alphaValueType", "type": "object", "properties": { "intValue": { "type": "string", "description": "Integer.", "format": "int64" }, "booleanValue": { "description": "Boolean.", "type": "boolean" }, "intArray": { "description": "Integer Array.", "$ref": "GoogleCloudIntegrationsV1alphaIntParameterArray" }, "stringArray": { "description": "String Array.", "$ref": "GoogleCloudIntegrationsV1alphaStringParameterArray" }, "stringValue": { "description": "String.", "type": "string" }, "booleanArray": { "$ref": "GoogleCloudIntegrationsV1alphaBooleanParameterArray", "description": "Boolean Array." }, "jsonValue": { "type": "string", "description": "Json." }, "doubleValue": { "format": "double", "description": "Double Number.", "type": "number" }, "doubleArray": { "$ref": "GoogleCloudIntegrationsV1alphaDoubleParameterArray", "description": "Double Number Array." } } }, "EnterpriseCrmEventbusStats": { "properties": { "dimensions": { "description": "Dimensions that these stats have been aggregated on.", "$ref": "EnterpriseCrmEventbusStatsDimensions" }, "errorRate": { "format": "double", "type": "number", "description": "Average error rate." }, "warningRate": { "type": "number", "format": "double", "description": "Average warning rate." }, "qps": { "format": "double", "type": "number", "description": "Queries per second." }, "durationInSeconds": { "type": "number", "description": "Average duration in seconds.", "format": "double" } }, "id": "EnterpriseCrmEventbusStats", "type": "object", "description": "Stats for the requested dimensions: QPS, duration, and error/warning rate" }, "GoogleCloudIntegrationsV1alphaIntegration": { "id": "GoogleCloudIntegrationsV1alphaIntegration", "type": "object", "description": "The integration definition.", "properties": { "creatorEmail": { "readOnly": true, "description": "Output only. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", "type": "string" }, "updateTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. Auto-generated.", "type": "string" }, "createTime": { "description": "Required. Output only. Auto-generated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "active": { "type": "boolean", "description": "Required. If any integration version is published." }, "name": { "description": "Required. The resource name of the integration.", "type": "string" }, "description": { "description": "Optional.", "type": "string" }, "lastModifierEmail": { "type": "string", "description": "Required. The last modifier of this integration" } } }, "GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest": { "description": "The request for scheduling an integration.", "properties": { "parameterEntries": { "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" }, "deprecated": true, "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", "type": "array" }, "userGeneratedExecutionId": { "type": "string", "description": "Optional. This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens." }, "requestId": { "description": "This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.", "type": "string" }, "parameters": { "deprecated": true, "$ref": "EnterpriseCrmEventbusProtoEventParameters", "description": "Passed in as parameters to each integration execution." }, "inputParameters": { "description": "Optional. Input parameters used by integration execution.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" } }, "triggerId": { "description": "Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)", "type": "string" }, "scheduleTime": { "format": "google-datetime", "description": "The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.", "type": "string" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest" }, "GoogleCloudIntegrationsV1alphaListAuthConfigsResponse": { "properties": { "authConfigs": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "type": "array", "description": "The list of AuthConfigs retrieved." }, "nextPageToken": { "description": "The token used to retrieve the next page of results.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaListAuthConfigsResponse", "type": "object", "description": "Response to list AuthConfigs." }, "GoogleCloudConnectorsV1ResourceLimits": { "properties": { "memory": { "type": "string", "readOnly": true, "description": "Output only. Memory limit." }, "cpu": { "description": "Output only. CPU limit.", "type": "string", "readOnly": true } }, "description": "Resource limits defined for connection pods of a given connector type.", "id": "GoogleCloudConnectorsV1ResourceLimits", "type": "object" }, "GoogleCloudConnectorsV1ResourceRequests": { "type": "object", "id": "GoogleCloudConnectorsV1ResourceRequests", "description": "Resource requests defined for connection pods of a given connector type.", "properties": { "cpu": { "readOnly": true, "description": "Output only. CPU request.", "type": "string" }, "memory": { "description": "Output only. Memory request.", "type": "string", "readOnly": true } } }, "GoogleCloudIntegrationsV1alphaSuspensionAudit": { "properties": { "resolveTime": { "format": "google-datetime", "description": "Time at which this suspension was resolved.", "type": "string" }, "resolver": { "type": "string", "description": "Email address of the person who resolved this suspension." } }, "type": "object", "description": "Contains when and by whom the suspension was resolved.", "id": "GoogleCloudIntegrationsV1alphaSuspensionAudit" }, "EnterpriseCrmEventbusProtoSuspensionExpiration": { "id": "EnterpriseCrmEventbusProtoSuspensionExpiration", "properties": { "expireAfterMs": { "format": "int32", "type": "integer", "description": "Milliseconds after which the suspension expires, if no action taken." }, "liftWhenExpired": { "description": "Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.", "type": "boolean" }, "remindAfterMs": { "format": "int32", "description": "Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.", "type": "integer" } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaExecutionSnapshot": { "type": "object", "description": "Contains the snapshot of the execution for a given checkpoint.", "id": "GoogleCloudIntegrationsV1alphaExecutionSnapshot", "properties": { "checkpointTaskNumber": { "description": "Indicates \"after which checkpoint task's execution\" this snapshot is taken.", "type": "string" }, "params": { "type": "object", "description": "Parameters used during the execution.", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" } }, "taskExecutionDetails": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaTaskExecutionDetails" }, "type": "array", "description": "All of the task execution details at the given point of time." }, "executionSnapshotMetadata": { "description": "Metadata of the execution snapshot.", "$ref": "GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata" } } }, "EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables": { "description": "Variables names mapped to api trigger.", "properties": { "names": { "type": "array", "description": "Optional. List of variable names.", "items": { "type": "string" } } }, "id": "EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables", "type": "object" }, "EnterpriseCrmEventbusProtoEventParameters": { "description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see", "id": "EnterpriseCrmEventbusProtoEventParameters", "type": "object", "properties": { "parameters": { "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", "items": { "$ref": "EnterpriseCrmEventbusProtoParameterEntry" }, "type": "array" } } }, "GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode": { "properties": { "tokenEndpoint": { "description": "The token url endpoint to send the token request to.", "type": "string" }, "tokenParams": { "$ref": "GoogleCloudIntegrationsV1alphaParameterMap", "description": "The token parameters sent along with the token request." }, "clientId": { "type": "string", "description": "The client's id." }, "applyReauthPolicy": { "type": "boolean", "description": "Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one." }, "requestType": { "type": "string", "enum": [ "REQUEST_TYPE_UNSPECIFIED", "REQUEST_BODY", "QUERY_PARAMETERS", "ENCODED_HEADER" ], "description": "Represent how to pass parameters to fetch access token", "enumDescriptions": [ "Unspecified request type", "To pass all the parameters in post body.", "To pass all the parameters as a part of query parameter.", "To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body." ] }, "authParams": { "description": "The auth parameters sent along with the auth code request.", "$ref": "GoogleCloudIntegrationsV1alphaParameterMap" }, "accessToken": { "description": "The access token received from the token endpoint.", "$ref": "GoogleCloudIntegrationsV1alphaAccessToken" }, "authCode": { "type": "string", "description": "The Auth Code that is used to initially retrieve the access token." }, "scope": { "description": "A space-delimited list of requested scope permissions.", "type": "string" }, "authEndpoint": { "description": "The auth url endpoint to send the auth code request to.", "type": "string" }, "clientSecret": { "description": "The client's secret.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCode", "type": "object", "description": "The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens." }, "EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage": { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParamSpecEntry" } } }, "id": "EnterpriseCrmFrontendsEventbusProtoParamSpecsMessage" }, "EnterpriseCrmEventbusProtoExternalTraffic": { "properties": { "gcpProjectId": { "type": "string", "description": "User’s GCP project id the traffic is referring to." }, "gcpProjectNumber": { "description": "User’s GCP project number the traffic is referring to.", "type": "string" }, "location": { "type": "string", "description": "Location for the user's request." }, "enableInternalIp": { "type": "boolean", "description": "Indicates the client enables internal IP feature, this is applicable for internal clients only." }, "retryRequestForQuota": { "type": "boolean", "description": "Enqueue the execution request due to quota issue" }, "source": { "type": "string", "enum": [ "SOURCE_UNSPECIFIED", "APIGEE", "SECURITY" ], "enumDescriptions": [ "", "WARNING: not the Apigee product. Marks external CUSTOMER traffic, including live Standalone IP clients, so deleting an `== APIGEE` branch breaks every external customer. SECURITY is the other external source (see ExternalTrafficUtils.EXTERNAL_SOURCES). Real Apigee test: !is_branded_as_standalone.", "" ] } }, "description": "Represents external traffic type and id.", "type": "object", "id": "EnterpriseCrmEventbusProtoExternalTraffic" }, "GoogleCloudIntegrationsV1alphaExecution": { "properties": { "executionMethod": { "description": "The ways user posts this event.", "type": "string", "enum": [ "EXECUTION_METHOD_UNSPECIFIED", "POST", "POST_TO_QUEUE", "SCHEDULE" ], "enumDescriptions": [ "Default value.", "Sync post.", "Async post.", "Async post with schedule time." ] }, "eventExecutionDetails": { "description": "The execution info about this event.", "$ref": "EnterpriseCrmEventbusProtoEventExecutionDetails", "deprecated": true }, "requestParameters": { "description": "Event parameters come in as part of the request.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" } }, "name": { "type": "string", "description": "Auto-generated primary key." }, "integrationVersionState": { "enumDescriptions": [ "Default.", "Draft.", "Active.", "Archived.", "Snapshot." ], "description": "Output only. State of the integration version", "readOnly": true, "type": "string", "enum": [ "INTEGRATION_STATE_UNSPECIFIED", "DRAFT", "ACTIVE", "ARCHIVED", "SNAPSHOT" ] }, "responseParameters": { "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, "type": "object", "description": "Event parameters returned as part of the response. In the case of error, the `ErrorInfo` field is returned in the following format: { \"ErrorInfo\": { \"message\": String, \"code\": Number } } " }, "cloudLoggingDetails": { "$ref": "GoogleCloudIntegrationsV1alphaCloudLoggingDetails", "description": "Cloud Logging details for the integration version" }, "requestParams": { "type": "array", "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" }, "deprecated": true, "description": "Event parameters come in as part of the request." }, "directSubExecutions": { "description": "Direct sub executions of the following Execution.", "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaExecution" } }, "updateTime": { "description": "Output only. Last modified time of the execution.", "readOnly": true, "type": "string", "format": "google-datetime" }, "responseParams": { "type": "array", "deprecated": true, "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" } }, "executionDetails": { "$ref": "GoogleCloudIntegrationsV1alphaExecutionDetails", "description": "Detailed info of this execution." }, "replayInfo": { "description": "Output only. Replay info for the execution", "$ref": "GoogleCloudIntegrationsV1alphaExecutionReplayInfo", "readOnly": true }, "cloudKmsKey": { "description": "Optional. Cloud KMS resource name for the CMEK encryption key.", "type": "string" }, "triggerId": { "type": "string", "description": "The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks." }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Created time of the execution.", "format": "google-datetime" }, "snapshotNumber": { "readOnly": true, "type": "string", "description": "Output only. An increasing sequence that is set when a new snapshot is created", "format": "int64" } }, "type": "object", "description": "The Execution resource contains detailed information of an individual integration execution.", "id": "GoogleCloudIntegrationsV1alphaExecution" }, "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter": { "properties": { "value": { "description": "Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.", "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, "parameter": { "description": "Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables.", "$ref": "GoogleCloudIntegrationsV1alphaIntegrationParameter" } }, "id": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter", "description": "Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.", "type": "object" }, "GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest": { "description": "Request for the ReplaceServiceAccount rpc", "properties": { "runAsServiceAccount": { "description": "Required. REQUIRED: Run-as service account to be updated", "type": "string" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest" }, "EnterpriseCrmFrontendsEventbusProtoTaskConfig": { "type": "object", "description": "The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.", "properties": { "synchronousCallFailurePolicy": { "$ref": "EnterpriseCrmEventbusProtoFailurePolicy", "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post)." }, "position": { "description": "Optional. Informs the front-end application where to draw this task config on the UI.", "$ref": "EnterpriseCrmEventbusProtoCoordinate" }, "taskName": { "type": "string", "description": "The name for the task." }, "externalTaskType": { "type": "string", "enum": [ "EXTERNAL_TASK_TYPE_UNSPECIFIED", "NORMAL_TASK", "ERROR_TASK" ], "enumDescriptions": [ "Default value. External task type is not specified", "Tasks belongs to the normal task flows", "Task belongs to the error catch task flows" ] }, "taskEntity": { "$ref": "EnterpriseCrmFrontendsEventbusProtoTaskEntity", "description": "Copy of the task entity that this task config is an instance of." }, "creatorEmail": { "description": "The creator's email address. Auto-generated from the user's email.", "type": "string" }, "jsonValidationOption": { "type": "string", "enum": [ "UNSPECIFIED_JSON_VALIDATION_OPTION", "SKIP", "PRE_EXECUTION", "POST_EXECUTION", "PRE_POST_EXECUTION" ], "description": "If set, overrides the option configured in the Task implementation class.", "enumDescriptions": [ "As per the default behavior, no validation will be run. Will not override any option set in a Task.", "Do not run any validation against JSON schemas.", "Validate all potential input JSON parameters against schemas specified in WorkflowParameters.", "Validate all potential output JSON parameters against schemas specified in WorkflowParameters.", "Perform both PRE_EXECUTION and POST_EXECUTION validations." ] }, "preconditionLabel": { "type": "string", "description": "Optional. User-provided label that is attached to precondition in the UI." }, "precondition": { "description": "Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. \"rollout(5)\" will only allow 5% of incoming traffic to task.", "type": "string" }, "parameters": { "type": "object", "description": "The customized parameters the user can pass to this task.", "additionalProperties": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" } }, "disableStrictTypeValidation": { "description": "If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.", "type": "boolean" }, "nextTasks": { "items": { "$ref": "EnterpriseCrmEventbusProtoNextTask" }, "description": "The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.", "type": "array" }, "conditionalFailurePolicies": { "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).", "$ref": "EnterpriseCrmEventbusProtoConditionalFailurePolicies" }, "successPolicy": { "description": "Determines what action to take upon successful task completion.", "$ref": "EnterpriseCrmEventbusProtoSuccessPolicy" }, "label": { "type": "string", "description": "User-provided label that is attached to this TaskConfig in the UI." }, "errorCatcherId": { "description": "Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task", "type": "string" }, "incomingEdgeCount": { "format": "int32", "description": "The number of edges leading into this TaskConfig.", "type": "integer" }, "failurePolicy": { "$ref": "EnterpriseCrmEventbusProtoFailurePolicy", "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.)." }, "alertConfigs": { "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoTaskAlertConfig" }, "description": "Alert configurations on error rate, warning rate, number of runs, durations, etc." }, "rollbackStrategy": { "description": "Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).", "$ref": "EnterpriseCrmFrontendsEventbusProtoRollbackStrategy" }, "nextTasksExecutionPolicy": { "enumDescriptions": [ "Default", "Execute all the tasks that satisfy their associated condition.", "Execute the first task that satisfies the associated condition." ], "description": "The policy dictating the execution of the next set of tasks for the current task.", "type": "string", "enum": [ "UNSPECIFIED", "RUN_ALL_MATCH", "RUN_FIRST_MATCH" ] }, "taskExecutionStrategy": { "enumDescriptions": [ "Wait until all of its previous tasks finished execution, then verify at least one of the edge conditions is met, and execute if possible. This should be considered as WHEN_ALL_TASKS_SUCCEED.", "Start execution as long as any of its previous tasks finished execution and the corresponding edge condition is met (since we will execute if only that succeeding edge condition is met).", "Wait until all of its previous tasks finished execution, then verify the all edge conditions are met and execute if possible." ], "type": "string", "enum": [ "WHEN_ALL_SUCCEED", "WHEN_ANY_SUCCEED", "WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED" ], "description": "The policy dictating the execution strategy of this task." }, "description": { "description": "User-provided description intended to give more business context about the task.", "type": "string" }, "lastModifiedTime": { "type": "string", "description": "Auto-generated.", "format": "google-datetime" }, "taskNumber": { "description": "REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).", "type": "string" }, "createTime": { "format": "google-datetime", "description": "Auto-generated.", "type": "string" }, "taskSpec": { "type": "string", "description": "A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old \"parameters\" field." }, "taskType": { "description": "Defines the type of the task", "enumDescriptions": [ "Normal IP task", "Task is of As-Is Template type", "Task is of I/O template type with a different underlying task" ], "type": "string", "enum": [ "TASK", "ASIS_TEMPLATE", "IO_TEMPLATE" ] }, "taskTemplateName": { "type": "string", "description": "Used to define task-template name if task is of type task-template" } }, "id": "EnterpriseCrmFrontendsEventbusProtoTaskConfig" }, "EnterpriseCrmFrontendsEventbusProtoParameterMap": { "properties": { "valueType": { "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "PROTO_VALUE", "SERIALIZED_OBJECT_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "PROTO_ARRAY", "PROTO_ENUM", "BOOLEAN_ARRAY", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY", "NON_SERIALIZABLE_OBJECT", "JSON_VALUE" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "", "", "" ] }, "entries": { "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapEntry" }, "type": "array" }, "keyType": { "description": "Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this.", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "", "", "" ], "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "PROTO_VALUE", "SERIALIZED_OBJECT_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "PROTO_ARRAY", "PROTO_ENUM", "BOOLEAN_ARRAY", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY", "NON_SERIALIZABLE_OBJECT", "JSON_VALUE" ] } }, "type": "object", "id": "EnterpriseCrmFrontendsEventbusProtoParameterMap", "description": "A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified." }, "EnterpriseCrmEventbusProtoField": { "properties": { "protoDefPath": { "type": "string", "description": "Optional. The fully qualified proto name (e.g. enterprise.crm.storage.Account). Required for output field of type PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES and output field_type is PROTO_VALUE, then fully qualified proto type url should be provided to parse the input bytes. If field_type is *_ARRAY, then all the converted protos are of the same type." }, "referenceKey": { "type": "string", "description": "This holds the reference key of the workflow or task parameter. 1. Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input or output parameter, for e.g. $task1_param1$. 3. Any workflow or task parameters with subfield references, for e.g., $task1_param1.employee.id$" }, "defaultValue": { "$ref": "EnterpriseCrmEventbusProtoParameterValueType", "description": "This holds the default values for the fields. This value is supplied by user so may or may not contain PII or SPII data." }, "transformExpression": { "description": "This is the transform expression to fetch the input field value. for e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can have a transform expression. 2. If a transform expression is provided, reference_key will be ignored. 3. If no value is returned after evaluation of transform expression, default_value can be mapped if provided. 4. The field_type should be the type of the final object returned after the transform expression is evaluated. Scrubs the transform expression before logging as value provided by user so may or may not contain PII or SPII data.", "$ref": "EnterpriseCrmEventbusProtoTransformExpression" }, "cardinality": { "type": "string", "enum": [ "UNSPECIFIED", "OPTIONAL" ], "enumDescriptions": [ "For fields with unspecified cardinality.", "If field cardinality is set to optional, ignore errors if input field value is null or the reference_key is not found." ], "description": "By default, if the cardinality is unspecified the field is considered required while mapping." }, "fieldType": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "", "", "" ], "description": "Specifies the data type of the field.", "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "PROTO_VALUE", "SERIALIZED_OBJECT_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "PROTO_ARRAY", "PROTO_ENUM", "BOOLEAN_ARRAY", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY", "NON_SERIALIZABLE_OBJECT", "JSON_VALUE" ] } }, "type": "object", "description": "Information about the value and type of the field.", "id": "EnterpriseCrmEventbusProtoField" }, "GoogleCloudIntegrationsV1alphaChangeCustomerConfigResponse": { "description": "Response for the ChangeCustomerConfig rpc", "id": "GoogleCloudIntegrationsV1alphaChangeCustomerConfigResponse", "properties": { "customerConfig": { "description": "Required. The updated customer configuration.", "$ref": "GoogleCloudIntegrationsV1alphaCustomerConfig" } }, "type": "object" }, "EnterpriseCrmEventbusProtoTriggerCriteria": { "id": "EnterpriseCrmEventbusProtoTriggerCriteria", "properties": { "condition": { "description": "Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.", "type": "string" }, "triggerCriteriaTaskImplementationClassName": { "description": "Optional. Implementation class name. The class should implement the “TypedTask” interface.", "type": "string" }, "parameters": { "$ref": "EnterpriseCrmEventbusProtoEventParameters", "description": "Optional. To be used in TaskConfig for the implementation class." } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaCloudKmsConfig": { "type": "object", "properties": { "kmsProjectId": { "description": "Optional. The gcp project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK", "type": "string" }, "kmsLocation": { "description": "Required. Location name of the key ring, e.g. \"us-west1\".", "type": "string" }, "key": { "description": "Required. A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.", "type": "string" }, "kmsRing": { "type": "string", "description": "Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location." }, "keyVersion": { "type": "string", "description": "Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data." } }, "description": "Configuration information for Client's Cloud KMS information", "id": "GoogleCloudIntegrationsV1alphaCloudKmsConfig" }, "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest": { "properties": { "requestId": { "description": "Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.", "type": "string" }, "parameters": { "description": "Passed in as parameters to each workflow execution. Optional.", "$ref": "EnterpriseCrmEventbusProtoEventParameters" }, "scheduledTime": { "description": "Optional. Time in milliseconds since epoch when the given event would be scheduled.", "type": "string", "format": "int64" }, "clientId": { "description": "Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.", "type": "string" }, "triggerId": { "description": "Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.", "type": "string" }, "ignoreErrorIfNoActiveWorkflow": { "description": "Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.", "type": "boolean" }, "userGeneratedExecutionId": { "type": "string", "description": "This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens." }, "testMode": { "type": "boolean", "description": "Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}." }, "workflowId": { "type": "string", "description": "Optional. Pins the enqueue to this exact version. Requires client_id, and only an ACTIVE version is accepted: the drain re-resolves by trigger id, so nothing else could run. Unset by every caller today; draft support is b/570602030. See integrationplatform/api/executionsservice/README.md." }, "resourceName": { "description": "This field is only required when using Admin Access. The resource name of target, or the parent resource name. For example: \"projects/*/locations/*/integrations/*\"", "type": "string" }, "quotaRetryCount": { "type": "integer", "format": "int32", "description": "Optional. This is a field to see the quota retry count for integration execution" }, "workflowName": { "description": "Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.", "type": "string" }, "priority": { "enumDescriptions": [ "Unspecified", "Frequent partial and occasional full unavailability is expected and not pageable. * Requests to this band will be shed before all other requests. * This is the default for async calls sent from batch jobs.", "Partial unavailability is expected and is not necessarily pageable. * Requests to this band will be shed before any critical traffic. * This is the default for async calls sent from production jobs.", "Any outage is a pageable event. * During a production outage requests in this band will only be shed before CRITICAL_PLUS. * This is the default for sync calls sent from production jobs.", "Any outage is a pageable event. * The guideline is for \u003c 10% of requests to a service to be in this band. * During a production outage requests in this band will be prioritized above all others. * Opt-in to CRITICAL_PLUS when your workflow triggers by human." ], "type": "string", "enum": [ "UNSPCIFIED", "SHEDDABLE", "SHEDDABLE_PLUS", "CRITICAL", "CRITICAL_PLUS" ], "description": "The request priority this request should be processed at. For internal users:" } }, "description": "LINT.IfChange Use this request to post all workflows associated with a given trigger id. Next available id: 14", "type": "object", "id": "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest" }, "GoogleCloudIntegrationsV1alphaSuspension": { "description": "A record representing a suspension.", "id": "GoogleCloudIntegrationsV1alphaSuspension", "properties": { "lastModifyTime": { "description": "Output only. Auto-generated.", "readOnly": true, "format": "google-datetime", "type": "string" }, "audit": { "$ref": "GoogleCloudIntegrationsV1alphaSuspensionAudit", "description": "Metadata pertaining to the resolution of this suspension." }, "approvalConfig": { "description": "Controls the notifications and approval permissions for this suspension.", "$ref": "GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig" }, "eventExecutionInfoId": { "description": "Required. ID of the associated execution.", "type": "string" }, "integration": { "description": "Required. The name of the originating integration.", "type": "string" }, "createTime": { "description": "Output only. Auto-generated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "taskId": { "description": "Required. Task id of the associated SuspensionTask.", "type": "string" }, "state": { "type": "string", "enum": [ "RESOLUTION_STATE_UNSPECIFIED", "PENDING", "REJECTED", "LIFTED" ], "enumDescriptions": [ "Unset state.", "The suspension has not yet been resolved.", "The resolver has rejected the suspension.", "The resolver has lifted the suspension." ], "description": "Required. State of this suspension, indicating what action a resolver has taken." }, "name": { "type": "string", "description": "Resource name for suspensions suspension/{suspension_id}" }, "suspensionConfig": { "deprecated": true, "description": "Controls the notifications and resolver permissions for this suspension.", "$ref": "EnterpriseCrmEventbusProtoSuspensionConfig" } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse": { "type": "object", "description": "Response to list SfdcInstances.", "properties": { "nextPageToken": { "description": "The token used to retrieve the next page of results.", "type": "string" }, "sfdcInstances": { "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "description": "The list of SfdcInstances retrieved." } }, "id": "GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse" }, "GoogleCloudIntegrationsV1alphaTemplateBundle": { "type": "object", "description": "Define the bundle of the template.", "id": "GoogleCloudIntegrationsV1alphaTemplateBundle", "properties": { "subIntegrationVersionTemplates": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate" }, "description": "Optional. Sub integration templates which would be added along with main integration.", "type": "array" }, "integrationVersionTemplate": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate", "description": "Required. Main integration templates of the template bundle." } } }, "GoogleCloudIntegrationsV1alphaClientCertificate": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaClientCertificate", "properties": { "sslCertificate": { "type": "string", "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----" }, "passphrase": { "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", "type": "string" }, "encryptedPrivateKey": { "type": "string", "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----" } }, "description": "Contains client certificate information" }, "GoogleCloudConnectorsV1HPAConfig": { "description": "Autoscaling config for connector deployment system metrics.", "properties": { "cpuUtilizationThreshold": { "format": "int64", "description": "Output only. Percent CPU utilization where HPA triggers autoscaling.", "type": "string", "readOnly": true }, "memoryUtilizationThreshold": { "type": "string", "readOnly": true, "format": "int64", "description": "Output only. Percent Memory utilization where HPA triggers autoscaling." } }, "type": "object", "id": "GoogleCloudConnectorsV1HPAConfig" }, "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity": { "properties": { "gaiaId": { "format": "int64", "type": "string" }, "emailAddress": { "type": "string" } }, "type": "object", "id": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity" }, "GoogleCloudIntegrationsV1alphaMockConfig": { "type": "object", "description": "The configuration for mocking of a task during test execution Next available id: 4", "id": "GoogleCloudIntegrationsV1alphaMockConfig", "properties": { "parameters": { "type": "array", "description": "Optional. List of key-value pairs for specific mock strategy", "items": { "$ref": "GoogleCloudIntegrationsV1alphaEventParameter" } }, "failedExecutions": { "format": "int64", "type": "string", "description": "Optional. Number of times the given task should fail for failure mock strategy" }, "mockStrategy": { "description": "Mockstrategy defines how the particular task should be mocked during test execution", "enumDescriptions": [ "This should never be used to annotate a field", "Execute actual task", "Don't execute actual task, instead use the values specified by user for output of the task", "Don't execute actual task, instead return task failure", "Don't execute actual task, instead mark it as successful" ], "type": "string", "enum": [ "MOCK_STRATEGY_UNSPECIFIED", "NO_MOCK_STRATEGY", "SPECIFIC_MOCK_STRATEGY", "FAILURE_MOCK_STRATEGY", "SKIP_MOCK_STRATEGY" ] } } }, "EnterpriseCrmEventbusProtoEventExecutionSnapshot": { "type": "object", "id": "EnterpriseCrmEventbusProtoEventExecutionSnapshot", "properties": { "eventExecutionSnapshotMetadata": { "$ref": "EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata" }, "exceedMaxSize": { "description": "indicate whether snapshot exceeded maximum size before clean up", "type": "boolean" }, "clientId": { "type": "string", "description": "Client that the execution snapshot is associated to." }, "eventParams": { "$ref": "EnterpriseCrmEventbusProtoEventParameters", "description": "The parameters in Event object." }, "conditionResults": { "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoConditionResult" }, "description": "All of the computed conditions that been calculated." }, "taskName": { "type": "string", "deprecated": true, "description": "The task name associated with this snapshot. Could be empty." }, "workflowName": { "description": "Name of the workflow this event execution snapshot belongs to.", "type": "string" }, "diffParams": { "description": "The parameters in Event object that differs from last snapshot.", "$ref": "EnterpriseCrmEventbusProtoEventParameters" }, "taskExecutionDetails": { "items": { "$ref": "EnterpriseCrmEventbusProtoTaskExecutionDetails" }, "description": "All of the task execution details at the given point of time.", "type": "array" }, "snapshotTime": { "type": "string", "description": "Indicates when this snapshot is taken.", "format": "int64" }, "eventExecutionInfoId": { "description": "Points to the event execution info this snapshot belongs to.", "type": "string" }, "checkpointTaskNumber": { "description": "Indicates \"right after which checkpoint task's execution\" this snapshot is taken.", "type": "string" }, "eventExecutionSnapshotId": { "type": "string", "description": "Auto-generated. Used as primary key for EventExecutionSnapshots table." } }, "description": "Contains the snapshot of the event execution for a given checkpoint. Next available id: 15" }, "GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecRequest": { "id": "GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecRequest", "type": "object", "description": "Request for GenerateOpenApiSpec.", "properties": { "apiTriggerResources": { "description": "Required. List of api triggers", "items": { "$ref": "GoogleCloudIntegrationsV1alphaApiTriggerResource" }, "type": "array" }, "fileFormat": { "enumDescriptions": [ "Unspecified file format", "JSON File Format", "YAML File Format" ], "description": "Required. File format for generated spec.", "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "JSON", "YAML" ] } } }, "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest": { "description": "Request for LinkAppsScriptProject rpc call.", "properties": { "scriptId": { "type": "string", "description": "The id of the Apps Script project to be linked." } }, "id": "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest", "type": "object" }, "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse": { "type": "object", "properties": { "integrations": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult" }, "description": "The list of integrations that match the search criteria.", "type": "array" }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } }, "id": "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse", "description": "Response for SearchIntegrations." }, "GoogleCloudIntegrationsV1alphaIntParameterArray": { "id": "GoogleCloudIntegrationsV1alphaIntParameterArray", "type": "object", "properties": { "intValues": { "type": "array", "items": { "type": "string", "format": "int64" }, "description": "Integer array." } }, "description": "This message only contains a field of integer array." }, "GoogleCloudIntegrationsV1alphaListIntegrationsResponse": { "properties": { "integrations": { "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegration" }, "description": "The integrations which match the request." }, "nextPageToken": { "description": "The next page token for the response.", "type": "string" } }, "type": "object", "description": "Response for ListIntegrations.", "id": "GoogleCloudIntegrationsV1alphaListIntegrationsResponse" }, "GoogleCloudIntegrationsV1alphaIntegrationAlertConfig": { "properties": { "aggregationPeriod": { "type": "string", "description": "The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours." }, "thresholdValue": { "description": "The metric value, above or below which the alert should be triggered.", "$ref": "GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue" }, "durationThreshold": { "type": "string", "description": "Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.", "format": "google-duration" }, "metricType": { "enumDescriptions": [ "The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.", "Specifies alerting on the rate of errors for the enclosing integration.", "Specifies alerting on the rate of warnings for the enclosing integration. Warnings use the same enum values as errors.", "Specifies alerting on the rate of errors for any task in the enclosing integration.", "Specifies alerting on the rate of warnings for any task in the enclosing integration.", "Specifies alerting on the rate of executions over all tasks in the enclosing integration.", "Specifies alerting on the number of events executed in the given aggregation_period.", "Specifies alerting on the average duration of executions for this integration.", "Specifies alerting on the duration value of a particular percentile of integration executions. E.g. If 10% or more of the integration executions have durations above 5 seconds, alert.", "Specifies alerting on the average duration of any task in the enclosing integration,", "Specifies alerting on the duration value of a particular percentile of any task executions within the enclosing integration. E.g. If 10% or more of the task executions in the integration have durations above 5 seconds, alert." ], "description": "The type of metric.", "type": "string", "enum": [ "METRIC_TYPE_UNSPECIFIED", "EVENT_ERROR_RATE", "EVENT_WARNING_RATE", "TASK_ERROR_RATE", "TASK_WARNING_RATE", "TASK_RATE", "EVENT_RATE", "EVENT_AVERAGE_DURATION", "EVENT_PERCENTILE_DURATION", "TASK_AVERAGE_DURATION", "TASK_PERCENTILE_DURATION" ] }, "onlyFinalAttempt": { "type": "boolean", "description": "For either events or tasks, depending on the type of alert, count only final attempts, not retries." }, "displayName": { "description": "Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.", "type": "string" }, "disableAlert": { "description": "Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.", "type": "boolean" }, "thresholdType": { "description": "The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.", "enumDescriptions": [ "Default.", "Note that this field will only trigger alerts if the integration specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that `aggregation_period` for this alert configuration must be less than 24 hours. Min value threshold.", "Max value threshold." ], "type": "string", "enum": [ "THRESHOLD_TYPE_UNSPECIFIED", "EXPECTED_MIN", "EXPECTED_MAX" ] }, "alertThreshold": { "format": "int32", "description": "For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.", "type": "integer" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaIntegrationAlertConfig", "description": "Message to be used to configure custom alerting in the {@code EventConfig} protos for an event." }, "GoogleCloudIntegrationsV1alphaCancelExecutionResponse": { "description": "Response for cancelling an execution.", "properties": { "isCanceled": { "description": "True if cancellation performed successfully.", "type": "boolean" } }, "id": "GoogleCloudIntegrationsV1alphaCancelExecutionResponse", "type": "object" }, "GoogleCloudIntegrationsV1alphaCloudSchedulerConfig": { "id": "GoogleCloudIntegrationsV1alphaCloudSchedulerConfig", "properties": { "location": { "type": "string", "description": "Required. The location where associated cloud scheduler job will be created" }, "errorMessage": { "type": "string", "description": "Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations" }, "serviceAccountEmail": { "description": "Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time", "type": "string" }, "cronTab": { "type": "string", "description": "Required. The cron tab of cloud scheduler trigger." } }, "description": "Cloud Scheduler Trigger configuration", "type": "object" }, "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse": { "id": "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse", "description": "The response for executing a functional test.", "type": "object", "properties": { "outputParameters": { "type": "object", "description": "OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.", "additionalProperties": { "description": "Properties of the object.", "type": "any" } }, "testExecutionState": { "enumDescriptions": [ "Unspecified state", "Test case execution passed", "Test case execution failed" ], "description": "State of the test case execution", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PASSED", "FAILED" ] }, "executionId": { "description": "The id of the execution corresponding to this run of integration.", "type": "string" }, "assertionResults": { "description": "Results of each assertions ran during execution of test case.", "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaAssertionResult" } } } }, "GoogleCloudConnectorsV1BillingConfig": { "properties": { "billingCategory": { "type": "string", "enum": [ "BILLING_CATEGORY_UNSPECIFIED", "GCP_AND_TECHNICAL_CONNECTOR", "NON_GCP_CONNECTOR" ], "enumDescriptions": [ "Billing category is not specified.", "GCP/Technical connector.", "Non-GCP connector." ], "readOnly": true, "description": "Output only. Billing category for the connector." } }, "id": "GoogleCloudConnectorsV1BillingConfig", "type": "object", "description": "Billing config for the connection." }, "GoogleCloudConnectorsV1LockConfig": { "type": "object", "id": "GoogleCloudConnectorsV1LockConfig", "properties": { "locked": { "type": "boolean", "description": "Optional. Indicates whether or not the connection is locked." }, "reason": { "type": "string", "description": "Optional. Describes why a connection is locked." } }, "description": "Determines whether or no a connection is locked. If locked, a reason must be specified." }, "EnterpriseCrmEventbusProtoValueType": { "description": "Used for define type for values. Currently supported value types include int, string, double, array, and any proto message.", "id": "EnterpriseCrmEventbusProtoValueType", "properties": { "intValue": { "format": "int64", "type": "string" }, "doubleValue": { "type": "number", "format": "double" }, "stringArray": { "$ref": "EnterpriseCrmEventbusProtoStringArray" }, "doubleArray": { "$ref": "EnterpriseCrmEventbusProtoDoubleArray" }, "protoValue": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "booleanValue": { "type": "boolean" }, "intArray": { "$ref": "EnterpriseCrmEventbusProtoIntArray" }, "stringValue": { "type": "string" } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaUploadTemplateResponse": { "id": "GoogleCloudIntegrationsV1alphaUploadTemplateResponse", "description": "Response for UploadTemplate.", "properties": { "template": { "$ref": "GoogleCloudIntegrationsV1alphaTemplate", "description": "The uploaded Template" } }, "type": "object" }, "GoogleCloudConnectorsV1EventingConfigDeadLetterConfig": { "type": "object", "description": "Dead Letter configuration details provided by the user.", "id": "GoogleCloudConnectorsV1EventingConfigDeadLetterConfig", "properties": { "topic": { "type": "string", "description": "Optional. Topic to push events which couldn't be processed." }, "projectId": { "type": "string", "description": "Optional. Project which has the topic given." } } }, "GoogleCloudIntegrationsV1alphaSuccessPolicy": { "id": "GoogleCloudIntegrationsV1alphaSuccessPolicy", "type": "object", "properties": { "finalState": { "description": "State to which the execution snapshot status will be set if the task succeeds.", "type": "string", "enum": [ "FINAL_STATE_UNSPECIFIED", "SUCCEEDED", "SUSPENDED" ], "enumDescriptions": [ "UNSPECIFIED.", "The default behavior, where successful tasks will be marked as SUCCEEDED.", "Sets the state to SUSPENDED after executing. This is required for SuspensionTask; event execution will continue once the user calls ResolveSuspensions with the event_execution_info_id and the task number." ] } }, "description": "Policy that dictates the behavior for the task after it completes successfully." }, "GoogleCloudIntegrationsV1alphaListTestCasesResponse": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaListTestCasesResponse", "description": "Response for ListTestCases", "properties": { "testCases": { "type": "array", "description": "The test cases corresponding to the specified filter", "items": { "$ref": "GoogleCloudIntegrationsV1alphaTestCase" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." } } }, "GoogleCloudIntegrationsV1alphaDoubleParameterArray": { "description": "This message only contains a field of double number array.", "type": "object", "properties": { "doubleValues": { "items": { "type": "number", "format": "double" }, "description": "Double number array.", "type": "array" } }, "id": "GoogleCloudIntegrationsV1alphaDoubleParameterArray" }, "GoogleCloudIntegrationsV1alphaTaskExecutionDetails": { "type": "object", "description": "Contains the details of the execution of this task.", "properties": { "taskAttemptStats": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaAttemptStats" }, "description": "Status for the current task execution attempt.", "type": "array" }, "taskExecutionState": { "type": "string", "enum": [ "TASK_EXECUTION_STATE_UNSPECIFIED", "PENDING_EXECUTION", "IN_PROCESS", "SUCCEED", "FAILED", "FATAL", "RETRY_ON_HOLD", "SKIPPED", "CANCELLED", "PENDING_ROLLBACK", "ROLLBACK_IN_PROCESS", "ROLLEDBACK", "SUSPENDED" ], "description": "The execution state of this task.", "enumDescriptions": [ "Default value.", "Task is waiting for its precondition tasks to finish to start the execution.", "Task is under processing.", "Task execution successfully finished. There's no more change after this state.", "Task execution failed. There's no more change after this state.", "Task execution failed and cause the whole integration execution to fail immediately. There's no more change after this state.", "Task execution failed and waiting for retry.", "Task execution skipped. This happens when its precondition wasn't met, or the integration execution been canceled before reach to the task. There's no more changes after this state.", "Task execution canceled when in progress. This happens when integration execution been canceled or any other task fall in fatal state.", "Task is waiting for its dependency tasks' rollback to finish to start its rollback.", "Task is rolling back.", "Task is rolled back. This is the state we will set regardless of rollback succeeding or failing.", "Task is a SuspensionTask which has executed once, creating a pending suspension." ] }, "taskNumber": { "type": "string", "description": "Pointer to the task config it used for execution." } }, "id": "GoogleCloudIntegrationsV1alphaTaskExecutionDetails" }, "GoogleCloudIntegrationsV1alphaAssertion": { "properties": { "retryCount": { "type": "integer", "description": "Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION", "format": "int32" }, "assertionStrategy": { "description": "Optional. The type of assertion to perform.", "type": "string", "enum": [ "ASSERTION_STRATEGY_UNSPECIFIED", "ASSERT_SUCCESSFUL_EXECUTION", "ASSERT_FAILED_EXECUTION", "ASSERT_NO_EXECUTION", "ASSERT_EQUALS", "ASSERT_NOT_EQUALS", "ASSERT_CONTAINS", "ASSERT_CONDITION" ], "enumDescriptions": [ "Unspecified Assertion strategy", "Test a successful execution", "Test a failed execution", "Test that the task was never executed", "Test the parameter selected is equal to the expected value", "Test the parameter selected is not equal to the expected value", "Test the parameter selected contains the configured value", "Test a specific condition" ] }, "condition": { "description": "Optional. Standard filter expression for ASSERT_CONDITION to succeed", "type": "string" }, "parameter": { "$ref": "GoogleCloudIntegrationsV1alphaEventParameter", "description": "Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed" } }, "id": "GoogleCloudIntegrationsV1alphaAssertion", "description": "An assertion which will check for a condition over task execution status or an expression for task output variables", "type": "object" }, "EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats": { "id": "EnterpriseCrmEventbusProtoTaskExecutionDetailsTaskAttemptStats", "type": "object", "properties": { "endTime": { "type": "string", "format": "int64", "description": "The end time of the task execution for current attempt." }, "startTime": { "description": "The start time of the task execution for current attempt. This could be in the future if it's been scheduled.", "type": "string", "format": "int64" } } }, "GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions": { "id": "GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions", "properties": { "webhookData": { "readOnly": true, "type": "array", "description": "Output only. Webhook data.", "items": { "$ref": "GoogleCloudConnectorsV1EventingRuntimeDataWebhookData" } } }, "description": "WebhookSubscriptions has details of webhook subscriptions.", "type": "object" }, "EnterpriseCrmEventbusProtoSuspensionConfig": { "type": "object", "id": "EnterpriseCrmEventbusProtoSuspensionConfig", "properties": { "whoMayResolve": { "items": { "$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissions" }, "description": "Identities able to resolve this suspension.", "type": "array" }, "customMessage": { "description": "Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.", "type": "string" }, "notifications": { "items": { "$ref": "EnterpriseCrmEventbusProtoNotification" }, "type": "array" }, "suspensionExpiration": { "$ref": "EnterpriseCrmEventbusProtoSuspensionExpiration", "description": "Indicates the next steps when no external actions happen on the suspension." } } }, "GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials": { "properties": { "tokenParams": { "description": "Token parameters for the auth request.", "$ref": "GoogleCloudIntegrationsV1alphaParameterMap" }, "requestType": { "description": "Represent how to pass parameters to fetch access token", "enumDescriptions": [ "Unspecified request type", "To pass all the parameters in post body.", "To pass all the parameters as a part of query parameter.", "To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body." ], "type": "string", "enum": [ "REQUEST_TYPE_UNSPECIFIED", "REQUEST_BODY", "QUERY_PARAMETERS", "ENCODED_HEADER" ] }, "clientId": { "description": "The client's ID.", "type": "string" }, "tokenEndpoint": { "description": "The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.", "type": "string" }, "accessToken": { "$ref": "GoogleCloudIntegrationsV1alphaAccessToken", "description": "Access token fetched from the authorization server." }, "scope": { "description": "A space-delimited list of requested scope permissions.", "type": "string" }, "clientSecret": { "description": "The client's secret.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaOAuth2ClientCredentials", "description": "For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token.", "type": "object" }, "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest": { "properties": { "configParameters": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Optional. Config parameters used during integration execution.", "type": "object" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest", "description": "Request for PublishIntegrationVersion." }, "GoogleCloudConnectorsV1ConnectionStatus": { "description": "ConnectionStatus indicates the state of the connection.", "type": "object", "id": "GoogleCloudConnectorsV1ConnectionStatus", "properties": { "status": { "description": "Status provides detailed information for the state.", "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "INACTIVE", "DELETING", "UPDATING", "ERROR", "AUTHORIZATION_REQUIRED" ], "description": "State.", "enumDescriptions": [ "Connection does not have a state yet.", "Connection is being created.", "Connection is running and ready for requests.", "Connection is stopped.", "Connection is being deleted.", "Connection is being updated.", "Connection is not running due to an error.", "Connection is not running because the authorization configuration is not complete." ] }, "description": { "type": "string", "description": "Description." } } }, "GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse": { "type": "object", "description": "Response for ListIntegrationVersions.", "properties": { "noPermission": { "description": "Whether the user has no permission on the version or not.", "type": "boolean" }, "integrationVersions": { "description": "The integrations which match the request.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse" }, "EnterpriseCrmEventbusProtoBaseValue": { "type": "object", "properties": { "literalValue": { "description": "Start with a literal value.", "$ref": "EnterpriseCrmEventbusProtoParameterValueType" }, "referenceValue": { "type": "string", "description": "Start with a reference value to dereference." }, "baseFunction": { "$ref": "EnterpriseCrmEventbusProtoFunction", "description": "Start with a function that does not build on existing values. Eg. CurrentTime, Min, Max, Exists, etc." } }, "id": "EnterpriseCrmEventbusProtoBaseValue" }, "GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest": { "properties": { "enableVariableMasking": { "type": "boolean", "description": "Required. REQUIRED: True if variable masking feature should be turned on for this region" } }, "id": "GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest", "description": "Request to enable/disable variable masking for a provisioned client", "type": "object" }, "EnterpriseCrmEventbusProtoTaskUiModuleConfig": { "description": "Task author would use this type to configure a config module.", "type": "object", "id": "EnterpriseCrmEventbusProtoTaskUiModuleConfig", "properties": { "moduleId": { "description": "ID of the config module.", "type": "string", "enum": [ "UNSPECIFIED_TASK_MODULE", "LABEL", "ERROR_HANDLING", "TASK_PARAM_TABLE", "TASK_PARAM_FORM", "PRECONDITION", "SCRIPT_EDITOR", "RPC", "TASK_SUMMARY", "SUSPENSION", "RPC_TYPED", "SUB_WORKFLOW", "APPS_SCRIPT_NAVIGATOR", "SUB_WORKFLOW_FOR_EACH_LOOP", "FIELD_MAPPING", "README", "REST_CALLER", "SUB_WORKFLOW_SCATTER_GATHER", "CLOUD_SQL", "GENERIC_CONNECTOR_TASK" ], "enumDescriptions": [ "Default", "Supports editing label of a task config.", "Supports editing error handling settings such as retry strategy.", "Supports adding, removing and editing task parameter values in a table with little assistance or restriction.", "Supports editing values of declared input parameters of a task. Think of it as a \"strongly typed\" upgrade to the TASK_PARAM_TABLE.", "Supports editing preconditions of a task config.", "Supports adding, editing, and deleting the scripts associated with a script task, as well as modifying the input/output parameters.", "Supports editing task parameters associated with an RPC/stubby task.", "Contains readonly task information, including input/output type info.", "Configures a SuspensionTask.", "Configures a GenericStubbyTypedTask.", "Configures a SubWorkflowExecutorTask.", "Supports navigating to Apps Script editor", "Configures a SubWorkflowForEachLoopTask.", "Configures a FieldMappingTask.", "Contains embedded in-product documentation for a task.", "UI widget for the rest caller task.", "Configures a SubWorkflowScatterGatherTask.", "Configures a CloudSql Task.", "Configure a GenericConnectorTask." ] } } }, "GoogleCloudIntegrationsV1alphaBooleanParameterArray": { "description": "This message only contains a field of boolean array.", "properties": { "booleanValues": { "type": "array", "description": "Boolean array.", "items": { "type": "boolean" } } }, "id": "GoogleCloudIntegrationsV1alphaBooleanParameterArray", "type": "object" }, "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse": { "properties": { "scriptId": { "type": "string", "description": "The id of the linked Apps Script project." } }, "id": "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse", "description": "Response for LinkAppsScriptProject rpc call.", "type": "object" }, "GoogleCloudIntegrationsV1alphaTriggerConfigVariables": { "properties": { "names": { "items": { "type": "string" }, "description": "Optional. List of variable names.", "type": "array" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaTriggerConfigVariables", "description": "Variables names mapped to api trigger." }, "EnterpriseCrmEventbusProtoParameterMap": { "id": "EnterpriseCrmEventbusProtoParameterMap", "type": "object", "properties": { "keyType": { "description": "Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this.", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "", "", "" ], "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "PROTO_VALUE", "SERIALIZED_OBJECT_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "PROTO_ARRAY", "PROTO_ENUM", "BOOLEAN_ARRAY", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY", "NON_SERIALIZABLE_OBJECT", "JSON_VALUE" ] }, "valueType": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "", "", "" ], "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "PROTO_VALUE", "SERIALIZED_OBJECT_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "PROTO_ARRAY", "PROTO_ENUM", "BOOLEAN_ARRAY", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY", "NON_SERIALIZABLE_OBJECT", "JSON_VALUE" ] }, "entries": { "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoParameterMapEntry" } } }, "description": "A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified." }, "GoogleCloudIntegrationsV1alphaUseTemplateRequest": { "properties": { "integrationDetails": { "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails", "description": "Required. Integration details which would be created via templates." }, "subIntegrations": { "description": "Optional. Sub Integration which would be created via templates.", "type": "object", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails" } }, "integrationRegion": { "type": "string", "description": "Required. The region of the Integration to be created." } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaUseTemplateRequest", "description": "Request to Use template" }, "GoogleCloudConnectorsV1Destination": { "type": "object", "properties": { "port": { "format": "int32", "description": "Optional. The port is the target port number that is accepted by the destination.", "type": "integer" }, "host": { "description": "For publicly routable host.", "type": "string" }, "serviceAttachment": { "type": "string", "deprecated": true, "description": "PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*" } }, "id": "GoogleCloudConnectorsV1Destination" }, "GoogleCloudIntegrationsV1alphaShareTemplateRequest": { "type": "object", "description": "Request to Share template", "properties": { "resourceNames": { "type": "array", "items": { "type": "string" }, "description": "Optional. Project name resources to share the template. The project names is expected in resource format Ex: projects/{project-number} or organization/{org-id}" } }, "id": "GoogleCloudIntegrationsV1alphaShareTemplateRequest" }, "GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecResponse": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecResponse", "properties": { "openApiSpec": { "description": "Open API spec as per the required format", "type": "string" } }, "description": "Response of the GenerateOpenApiSpec API." }, "GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest": { "properties": { "cloudKmsConfig": { "description": "Required. REQUIRED: Cloud KMS config for AuthModule to encrypt/decrypt credentials.", "$ref": "GoogleCloudIntegrationsV1alphaCloudKmsConfig" } }, "id": "GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest", "type": "object", "description": "Request for the SwitchEncryption rpc" }, "GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorRequest": { "type": "object", "properties": { "workflows": { "items": { "type": "string", "enum": [ "SAMPLE_INTEGRATIONS_UNSPECIFIED", "SAMPLE_WORKFLOW_ECOM_PROCESSING", "EXECUTE_CONNECTOR_TOOL_WORKFLOW" ], "enumDescriptions": [ "Default value, should not be used.", "Ecom processing workflow", "Connector tool workflow" ] }, "type": "array", "description": "Optional. Indicate which workflows to create" } }, "id": "GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorRequest", "description": "Request for PostProvisioning rpc call." }, "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest": { "description": "Request for CreateAppsScriptProject rpc call.", "properties": { "authConfigId": { "description": "The auth config id necessary to fetch the necessary credentials to create the project for external clients", "type": "string" }, "appsScriptProject": { "description": "The name of the Apps Script project to be created.", "type": "string" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest" }, "EnterpriseCrmEventbusProtoTaskMetadata": { "description": "TaskMetadata are attributes that are associated to every common Task we have.", "properties": { "descriptiveName": { "description": "The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. \"Send Mail\")", "type": "string" }, "activeTaskName": { "description": "The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.", "type": "string" }, "externalCategorySequence": { "description": "Sequence with which the task in specific category to be displayed in task discovery panel for external users.", "format": "int32", "type": "integer" }, "externalDocHtml": { "type": "string", "description": "External-facing documention embedded in the RHP for this task." }, "admins": { "items": { "$ref": "EnterpriseCrmEventbusProtoTaskMetadataAdmin" }, "type": "array" }, "externalDocLink": { "type": "string", "description": "Doc link for external-facing documentation (separate from g3doc)." }, "category": { "type": "string", "enum": [ "UNSPECIFIED_CATEGORY", "CUSTOM", "FLOW_CONTROL", "DATA_MANIPULATION", "SCRIPTING", "CONNECTOR", "HIDDEN", "CLOUD_SYSTEMS", "CUSTOM_TASK_TEMPLATE", "TASK_RECOMMENDATIONS" ], "enumDescriptions": [ "", "", "", "", "", "", "Internal IP tasks that should not be available in the UI.", "Tasks that are relevant to cloud systems teams and typically", "Task entities that derive from a custom task template.", "Category to show task recommendations" ] }, "status": { "enumDescriptions": [ "Default value. Actual Task Status should always be set to either INACTIVE or ACTIVE. If none is specified at runtime, it will be set to INACTIVE.", "Still in-progress or incomplete, and not intended for use.", "Available for use." ], "type": "string", "enum": [ "UNSPECIFIED_STATUS", "DEFAULT_INACTIVE", "ACTIVE" ], "description": "Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE." }, "standaloneExternalDocHtml": { "type": "string", "description": "External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html" }, "iconLink": { "description": "URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format.", "type": "string" }, "defaultJsonValidationOption": { "enumDescriptions": [ "As per the default behavior, no validation will be run. Will not override any option set in a Task.", "Do not run any validation against JSON schemas.", "Validate all potential input JSON parameters against schemas specified in WorkflowParameters.", "Validate all potential output JSON parameters against schemas specified in WorkflowParameters.", "Perform both PRE_EXECUTION and POST_EXECUTION validations." ], "description": "Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.", "type": "string", "enum": [ "UNSPECIFIED_JSON_VALIDATION_OPTION", "SKIP", "PRE_EXECUTION", "POST_EXECUTION", "PRE_POST_EXECUTION" ] }, "isDeprecated": { "type": "boolean", "description": "The deprecation status of the current task. Default value is false;" }, "system": { "type": "string", "enum": [ "UNSPECIFIED_SYSTEM", "GENERIC", "BUGANIZER", "SALESFORCE", "CLOUD_SQL", "PLX", "SHEETS", "GOOGLE_GROUPS", "EMAIL", "SPANNER", "DATA_BRIDGE" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "" ] }, "defaultSpec": { "description": "Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.", "type": "string" }, "codeSearchLink": { "type": "string", "description": "The Code Search link to the Task Java file." }, "externalCategory": { "enumDescriptions": [ "", "", "", "HTTP tasks, e.g. rest api call task", "Integration services, e.g. connector task", "Customer ations, e.g. email task", "Flow control, e.g. while loop task", "Workspace tasks, e.g. list drive task", "Security, e.g. kms related tasks", "Database operation tasks, e.g. read firestore info tasks", "Analytics tasks, e.g. dataflow creattion tasks", "BYOC tasks", "BYOT tasks", "AI related tasks.", "Data manipulation related tasks, e.g. data mapping task" ], "type": "string", "enum": [ "UNSPECIFIED_EXTERNAL_CATEGORY", "CORE", "CONNECTORS", "EXTERNAL_HTTP", "EXTERNAL_INTEGRATION_SERVICES", "EXTERNAL_CUSTOMER_ACTIONS", "EXTERNAL_FLOW_CONTROL", "EXTERNAL_WORKSPACE", "EXTERNAL_SECURITY", "EXTERNAL_DATABASES", "EXTERNAL_ANALYTICS", "EXTERNAL_BYOC", "EXTERNAL_BYOT", "EXTERNAL_ARTIFICIAL_INTELIGENCE", "EXTERNAL_DATA_MANIPULATION" ] }, "g3DocLink": { "type": "string", "description": "URL to the associated G3 Doc for the task if available" }, "name": { "type": "string", "description": "The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class." }, "description": { "type": "string", "description": "In a few sentences, describe the purpose and usage of the task." }, "tags": { "type": "array", "description": "A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names (\"REST Caller\" vs. \"Call REST Endpoint\") or to help users find tasks based on related words.", "items": { "type": "string" } }, "externalDocMarkdown": { "description": "DEPRECATED: Use external_doc_html.", "type": "string" }, "docMarkdown": { "description": "Snippet of markdown documentation to embed in the RHP for this task.", "type": "string" } }, "type": "object", "id": "EnterpriseCrmEventbusProtoTaskMetadata" }, "GoogleCloudIntegrationsV1alphaTestCase": { "description": "Defines the functional test case for Application Integration. Next available id: 15", "type": "object", "id": "GoogleCloudIntegrationsV1alphaTestCase", "properties": { "lastModifierEmail": { "description": "The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", "type": "string" }, "lockHolderEmail": { "type": "string", "description": "Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call." }, "creatorEmail": { "description": "Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", "type": "string" }, "triggerConfig": { "description": "Optional. Auto-generated.", "$ref": "GoogleCloudIntegrationsV1alphaTriggerConfig" }, "description": { "type": "string", "description": "Optional. Description of the test case." }, "updateTime": { "description": "Auto-generated.", "type": "string", "format": "google-datetime" }, "testTaskConfigs": { "type": "array", "description": "Optional. However, the test case doesn't mock or assert anything without test_task_configs.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaTestTaskConfig" } }, "createTime": { "description": "Auto-generated.", "format": "google-datetime", "type": "string" }, "triggerId": { "type": "string", "description": "Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case" }, "databasePersistencePolicy": { "enumDescriptions": [ "Enables persistence for all execution data.", "Disables persistence for all execution data.", "Asynchronously persist all execution data." ], "description": "Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..", "type": "string", "enum": [ "DATABASE_PERSISTENCE_POLICY_UNSPECIFIED", "DATABASE_PERSISTENCE_DISABLED", "DATABASE_PERSISTENCE_ASYNC" ] }, "name": { "type": "string", "description": "Output only. Auto-generated primary key.", "readOnly": true }, "testInputParameters": { "description": "Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.", "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationParameter" } }, "displayName": { "type": "string", "description": "Required. The display name of test case." } } }, "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange": { "description": "Range used to validate longs and ints.", "id": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleIntRange", "type": "object", "properties": { "min": { "description": "The inclusive minimum of the acceptable range.", "type": "string", "format": "int64" }, "max": { "description": "The inclusive maximum of the acceptable range.", "format": "int64", "type": "string" } } }, "GoogleCloudIntegrationsV1alphaTaskConfig": { "properties": { "task": { "description": "Optional. The name for the task.", "type": "string" }, "taskExecutionStrategy": { "enumDescriptions": [ "Default. If the strategy is not set explicitly, it will default to `WHEN_ALL_SUCCEED`.", "Wait until all of its previous tasks finished execution, then verify at least one of the edge conditions is met, and execute if possible. This should be considered as WHEN_ALL_TASKS_SUCCEED.", "Start execution as long as any of its previous tasks finished execution and the corresponding edge condition is met (since we will execute if only that succeeding edge condition is met).", "Wait until all of its previous tasks finished execution, then verify the all edge conditions are met and execute if possible." ], "type": "string", "enum": [ "TASK_EXECUTION_STRATEGY_UNSPECIFIED", "WHEN_ALL_SUCCEED", "WHEN_ANY_SUCCEED", "WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED" ], "description": "Optional. The policy dictating the execution strategy of this task." }, "displayName": { "type": "string", "description": "Optional. User-provided label that is attached to this TaskConfig in the UI." }, "conditionalFailurePolicies": { "description": "Optional. The list of conditional failure policies that will be applied to the task in order.", "$ref": "GoogleCloudIntegrationsV1alphaConditionalFailurePolicies" }, "failurePolicy": { "$ref": "GoogleCloudIntegrationsV1alphaFailurePolicy", "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.)." }, "taskTemplate": { "description": "Optional. Used to define task-template name if task is of type task-template", "type": "string" }, "parameters": { "type": "object", "description": "Optional. The customized parameters the user can pass to this task.", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaEventParameter" } }, "nextTasks": { "type": "array", "description": "Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaNextTask" } }, "description": { "description": "Optional. User-provided description intended to give additional business context about the task.", "type": "string" }, "taskId": { "description": "Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).", "type": "string" }, "successPolicy": { "$ref": "GoogleCloudIntegrationsV1alphaSuccessPolicy", "description": "Optional. Determines what action to take upon successful task completion." }, "errorCatcherId": { "description": "Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task", "type": "string" }, "externalTaskType": { "enumDescriptions": [ "Default value. External task type is not specified", "Tasks belongs to the normal task flows", "Task belongs to the error catch task flows" ], "type": "string", "enum": [ "EXTERNAL_TASK_TYPE_UNSPECIFIED", "NORMAL_TASK", "ERROR_TASK" ], "description": "Optional. External task type of the task" }, "position": { "$ref": "GoogleCloudIntegrationsV1alphaCoordinate", "description": "Optional. Informs the front-end application where to draw this error catcher config on the UI." }, "synchronousCallFailurePolicy": { "$ref": "GoogleCloudIntegrationsV1alphaFailurePolicy", "description": "Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post)." }, "jsonValidationOption": { "enumDescriptions": [ "As per the default behavior, no validation will be run. Will not override any option set in a Task.", "Do not run any validation against JSON schemas.", "Validate all potential input JSON parameters against schemas specified in IntegrationParameter.", "Validate all potential output JSON parameters against schemas specified in IntegrationParameter.", "Perform both PRE_EXECUTION and POST_EXECUTION validations." ], "type": "string", "enum": [ "JSON_VALIDATION_OPTION_UNSPECIFIED", "SKIP", "PRE_EXECUTION", "POST_EXECUTION", "PRE_POST_EXECUTION" ], "description": "Optional. If set, overrides the option configured in the Task implementation class." }, "nextTasksExecutionPolicy": { "description": "Optional. The policy dictating the execution of the next set of tasks for the current task.", "type": "string", "enum": [ "NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED", "RUN_ALL_MATCH", "RUN_FIRST_MATCH" ], "enumDescriptions": [ "Default.", "Execute all the tasks that satisfy their associated condition.", "Execute the first task that satisfies the associated condition." ] } }, "type": "object", "description": "The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.", "id": "GoogleCloudIntegrationsV1alphaTaskConfig" }, "EnterpriseCrmEventbusProtoDoubleFunction": { "id": "EnterpriseCrmEventbusProtoDoubleFunction", "type": "object", "properties": { "functionName": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNSPECIFIED", "TO_JSON", "TO_STRING", "ADD", "SUBTRACT", "MULTIPLY", "DIVIDE", "EXPONENT", "ROUND", "FLOOR", "CEIL", "GREATER_THAN", "LESS_THAN", "EQUALS", "GREATER_THAN_EQUALS", "LESS_THAN_EQUALS", "MOD" ] } } }, "GoogleCloudConnectorsV1EventingRuntimeDataWebhookData": { "properties": { "nextRefreshTime": { "format": "google-datetime", "description": "Output only. Next webhook refresh time. Will be null if refresh is not supported.", "type": "string", "readOnly": true }, "additionalVariables": { "description": "Output only. Additional webhook related field values.", "type": "array", "readOnly": true, "items": { "$ref": "GoogleCloudConnectorsV1ConfigVariable" } }, "id": { "description": "Output only. ID to uniquely identify webhook.", "readOnly": true, "type": "string" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Timestamp when the webhook was created." }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Timestamp when the webhook was last updated.", "readOnly": true }, "name": { "readOnly": true, "type": "string", "description": "Output only. Name of the Webhook" }, "eventTypes": { "description": "Output only. List of event types for the webhook. This is the event types subscribed by the current webhook.", "items": { "type": "string" }, "type": "array", "readOnly": true }, "eventSubscriptions": { "type": "array", "readOnly": true, "items": { "type": "string" }, "description": "Output only. List of event subscriptions which are using the webhook." } }, "description": "WebhookData has details of webhook configuration.", "id": "GoogleCloudConnectorsV1EventingRuntimeDataWebhookData", "type": "object" }, "EnterpriseCrmEventbusProtoEventBusProperties": { "type": "object", "description": "LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus.", "id": "EnterpriseCrmEventbusProtoEventBusProperties", "properties": { "properties": { "type": "array", "description": "An unordered list of property entries.", "items": { "$ref": "EnterpriseCrmEventbusProtoPropertyEntry" } } } }, "GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaExecutionSnapshotExecutionSnapshotMetadata", "description": "Metadata of the execution snapshot.", "properties": { "integrationName": { "description": "The direct integration which the event execution snapshots belongs to", "type": "string" }, "ancestorIterationNumbers": { "description": "Ancestor iteration number for the task(it will only be non-empty if the task is under 'private workflow')", "type": "array", "items": { "type": "string" } }, "taskAttempt": { "type": "integer", "description": "the task attempt number this snapshot belongs to.", "format": "int32" }, "taskLabel": { "type": "string", "description": "the task label associated with this snapshot. Could be empty." }, "ancestorTaskNumbers": { "description": "Ancestor task number for the task(it will only be non-empty if the task is under 'private workflow')", "items": { "type": "string" }, "type": "array" }, "executionAttempt": { "format": "int32", "type": "integer", "description": "the execution attempt number this snapshot belongs to." }, "taskNumber": { "type": "string", "description": "The task number associated with this snapshot." }, "task": { "type": "string", "description": "the task name associated with this snapshot." } } }, "GoogleCloudIntegrationsV1alphaUsernameAndPassword": { "id": "GoogleCloudIntegrationsV1alphaUsernameAndPassword", "properties": { "username": { "description": "Username to be used", "type": "string" }, "password": { "description": "Password to be used", "type": "string" } }, "description": "Username and password pair.", "type": "object" }, "EnterpriseCrmEventbusProtoFailurePolicy": { "type": "object", "id": "EnterpriseCrmEventbusProtoFailurePolicy", "description": "Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).", "properties": { "retryStrategy": { "description": "Defines what happens to the task upon failure.", "enumDescriptions": [ "", "Ignores the failure of this task. The rest of the workflow will be executed Assuming this task succeeded.", "Causes a permanent failure of the task. However, if the last task(s) of event was successfully completed despite the failure of this task, it has no impact on the workflow.", "Causes a permanent failure of the event. It is different from NONE because this will mark the event as FAILED by shutting down the event execution.", "The task will be retried from the failed task onwards after a fixed delay. A max-retry count is required to be specified with this strategy. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. Max_num_retries and interval_in_seconds must be specified.", "The task will be retried from the failed task onwards after a fixed delay that linearly increases with each retry attempt. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. Max_num_retries and interval_in_seconds must be specified.", "The task will be retried after an exponentially increasing period of time with each failure. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. `max_num_retries` and `interval_in_seconds` must be specified.", "The entire workflow will be restarted with the initial parameters that were set when the event was fired. A max-retry count is required to be specified with this strategy. `max_num_retries` and `interval_in_seconds` must be specified." ], "type": "string", "enum": [ "UNSPECIFIED", "IGNORE", "NONE", "FATAL", "FIXED_INTERVAL", "LINEAR_BACKOFF", "EXPONENTIAL_BACKOFF", "RESTART_WORKFLOW_WITH_BACKOFF" ] }, "retryCondition": { "description": "Optional. The retry condition that will be evaluated for this failure policy with the corresponding retry strategy.", "type": "string" }, "intervalInSeconds": { "description": "Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.", "type": "string", "format": "int64" }, "maxNumRetries": { "description": "Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.", "type": "integer", "format": "int32" } } }, "EnterpriseCrmEventbusProtoDoubleArray": { "id": "EnterpriseCrmEventbusProtoDoubleArray", "properties": { "values": { "type": "array", "items": { "format": "double", "type": "number" } } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaImportTemplateResponse": { "id": "GoogleCloudIntegrationsV1alphaImportTemplateResponse", "description": "Response for import template", "type": "object", "properties": { "subIntegrationVersions": { "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "description": "Sub integration versions which are imported." }, "integrationVersion": { "description": "IntegrationVersion after the import.", "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" } } }, "GoogleCloudIntegrationsV1alphaReplayExecutionResponse": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaReplayExecutionResponse", "properties": { "executionId": { "type": "string", "description": "Next ID: 4 The id of the execution corresponding to this run of the integration." }, "replayedExecutionId": { "description": "The execution id which is replayed.", "type": "string" }, "outputParameters": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "OUTPUT parameters in format of Map. Where Key is the name of the parameter. The parameters would only be present in case of synchrounous execution. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters." } }, "description": "Response for replaying an execution." }, "GoogleCloudIntegrationsV1alphaImportTemplateRequest": { "properties": { "subIntegrations": { "type": "object", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails" }, "description": "Optional. Sub Integration which would be created via templates." }, "integration": { "description": "Required. Resource Name of the integration where template needs to be imported/inserted.", "type": "string" } }, "description": "Request to Import template", "type": "object", "id": "GoogleCloudIntegrationsV1alphaImportTemplateRequest" }, "EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition": { "properties": { "path": { "type": "string", "description": "Path to the proto file that contains the message type's definition." }, "fullName": { "type": "string", "description": "The fully-qualified proto name. This message, for example, would be \"enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition\"." } }, "type": "object", "id": "EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition" }, "GoogleCloudIntegrationsV1alphaTestIntegrationsResponse": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaTestIntegrationsResponse", "description": "The response for testing an integration.", "properties": { "eventParameters": { "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "description": "Details for the integration that were executed.", "deprecated": true }, "parameters": { "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, "type": "object", "description": "Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution." }, "credentialMode": { "enumDescriptions": [ "Resolves based on when the test runs; see `TestIntegrationsRequest.credential_mode`.", "The flow production runs for this integration today.", "The flow an integration created after the EUC hardening cutover runs. Covers this integration's own tasks; a sub-integration it calls runs under its own stored disposition. When requested explicitly, fails with `FAILED_PRECONDITION` where the hardened flow cannot be evaluated, and with `UNIMPLEMENTED` for asynchronous tests." ], "type": "string", "enum": [ "CREDENTIAL_MODE_UNSPECIFIED", "CREDENTIAL_MODE_CURRENT", "CREDENTIAL_MODE_HARDENED" ], "description": "The credential flow the test ran under. Unset for asynchronous tests." }, "parameterEntries": { "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" }, "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", "deprecated": true, "type": "array" }, "executionFailed": { "type": "boolean", "description": "Is true if any execution in the integration failed. False otherwise." }, "executionId": { "description": "The id of the execution corresponding to this run of integration.", "type": "string" }, "eucHardeningDisposition": { "enumDescriptions": [ "Not recorded: the version predates the disposition, or the integration was created before a cutover date applied to its region.", "The integration was first created before the cutover.", "The integration was first created at or after the cutover." ], "description": "The EUC hardening disposition stored for the tested integration, read before the run. Unset for asynchronous tests.", "type": "string", "enum": [ "EUC_HARDENING_DISPOSITION_UNSPECIFIED", "LEGACY", "HARDENED" ] }, "hardenedPaths": { "items": { "type": "string", "enum": [ "HARDENED_PATH_UNSPECIFIED", "SCRIPT_EVAL", "STUBBY_CALLER", "SUB_INTEGRATION" ], "enumDescriptions": [ "Unspecified.", "Script evaluation by JavaScript and Jsonnet tasks, including Data Transformer.", "The Generic Stubby task's lookup of the method it calls.", "A Call Integration task's call to the integration it calls." ] }, "description": "The credential paths the hardened flow covers for this test: each one that a task in the tested integration reaches and that the server running the test hardens, whatever the credential mode. A `CREDENTIAL_MODE_CURRENT` test of an integration not stored as hardened usually lists none, and a `CREDENTIAL_MODE_HARDENED` response with no paths means nothing in this integration was hardened. Empty where the hardened flow is switched off. Unset for asynchronous tests. Derived from the integration's task types before the run: it reports presence in the graph, not execution, so a task on a branch that did not run is still counted, as is a Call Integration task that runs as a configured service account. A sub-integration's own tasks are not included; each runs under its own stored disposition. Integration Connectors tasks and Cloud Scheduler triggers are never reported: the services they call do not yet accept the hardened credential.", "type": "array" } } }, "GoogleCloudIntegrationsV1alphaParameterMapEntry": { "properties": { "key": { "description": "Key of the map entry.", "$ref": "GoogleCloudIntegrationsV1alphaParameterMapField" }, "value": { "description": "Value of the map entry.", "$ref": "GoogleCloudIntegrationsV1alphaParameterMapField" } }, "id": "GoogleCloudIntegrationsV1alphaParameterMapEntry", "type": "object", "description": "Entry is a pair of key and value." }, "EnterpriseCrmEventbusProtoIntParameterArray": { "properties": { "intValues": { "type": "array", "items": { "format": "int64", "type": "string" } } }, "type": "object", "id": "EnterpriseCrmEventbusProtoIntParameterArray" }, "EnterpriseCrmEventbusProtoConditionalFailurePolicies": { "id": "EnterpriseCrmEventbusProtoConditionalFailurePolicies", "type": "object", "properties": { "failurePolicies": { "type": "array", "description": "The list of failure policies that will be applied to the task in order.", "items": { "$ref": "EnterpriseCrmEventbusProtoFailurePolicy" } }, "defaultFailurePolicy": { "description": "The default failure policy to be applied if no conditional failure policy matches", "$ref": "EnterpriseCrmEventbusProtoFailurePolicy" } } }, "GoogleCloudIntegrationsV1alphaCoordinate": { "properties": { "y": { "format": "int32", "type": "integer", "description": "Required. Y axis of the coordinate" }, "x": { "format": "int32", "description": "Required. X axis of the coordinate", "type": "integer" } }, "type": "object", "description": "Configuration detail of coordinate, it used for UI", "id": "GoogleCloudIntegrationsV1alphaCoordinate" }, "GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse": { "id": "GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse", "properties": { "triggerUrl": { "description": "The trigger url that will be returned", "type": "string" } }, "type": "object", "description": "Response for Creating Cloud Function rpc call." }, "EnterpriseCrmEventbusProtoCoordinate": { "id": "EnterpriseCrmEventbusProtoCoordinate", "type": "object", "properties": { "x": { "format": "int32", "type": "integer" }, "y": { "format": "int32", "type": "integer" } }, "description": "Represents two-dimensional positions." }, "EnterpriseCrmFrontendsEventbusProtoTriggerConfig": { "properties": { "nextTasksExecutionPolicy": { "enumDescriptions": [ "Default", "Execute all the tasks that satisfy their associated condition.", "Execute the first task that satisfies the associated condition." ], "type": "string", "enum": [ "UNSPECIFIED", "RUN_ALL_MATCH", "RUN_FIRST_MATCH" ], "description": "Dictates how next tasks will be executed." }, "triggerCriteria": { "$ref": "EnterpriseCrmEventbusProtoTriggerCriteria", "description": "Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true." }, "description": { "type": "string", "description": "User-provided description intended to give more business context about the task." }, "label": { "description": "The user created label for a particular trigger.", "type": "string" }, "properties": { "description": "Configurable properties of the trigger, not to be confused with workflow parameters. E.g. \"name\" is a property for API triggers and \"subscription\" is a property for Cloud Pubsub triggers.", "additionalProperties": { "type": "string" }, "type": "object" }, "errorCatcherId": { "description": "Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task", "type": "string" }, "alertConfig": { "description": "An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.", "items": { "$ref": "EnterpriseCrmEventbusProtoWorkflowAlertConfig" }, "type": "array" }, "outputVariables": { "$ref": "EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables", "description": "Optional. List of output variables for the api trigger." }, "triggerNumber": { "type": "string", "description": "Required. A number to uniquely identify each trigger config within the workflow on UI." }, "position": { "description": "Optional. Informs the front-end application where to draw this trigger config on the UI.", "$ref": "EnterpriseCrmEventbusProtoCoordinate" }, "triggerName": { "type": "string", "description": "Optional. Name of the trigger This is added to identify the type of trigger. This is avoid the logic on triggerId to identify the trigger_type and push the same to monitoring." }, "cloudSchedulerConfig": { "$ref": "EnterpriseCrmEventbusProtoCloudSchedulerConfig" }, "triggerId": { "description": "The backend trigger ID.", "type": "string" }, "pauseWorkflowExecutions": { "type": "boolean", "description": "Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed." }, "enabledClients": { "items": { "type": "string" }, "description": "Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.", "type": "array" }, "inputVariables": { "$ref": "EnterpriseCrmFrontendsEventbusProtoTriggerConfigVariables", "description": "Optional. List of input variables for the api trigger." }, "startTasks": { "items": { "$ref": "EnterpriseCrmEventbusProtoNextTask" }, "description": "Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).", "type": "array" }, "triggerType": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNKNOWN", "CLOUD_PUBSUB", "GOOPS", "SFDC_SYNC", "CRON", "API", "MANIFOLD_TRIGGER", "DATALAYER_DATA_CHANGE", "SFDC_CHANNEL", "CLOUD_PUBSUB_EXTERNAL", "SFDC_CDC_CHANNEL", "SFDC_PLATFORM_EVENTS_CHANNEL", "CLOUD_SCHEDULER", "INTEGRATION_CONNECTOR_TRIGGER", "PRIVATE_TRIGGER", "EVENTARC_TRIGGER" ] } }, "id": "EnterpriseCrmFrontendsEventbusProtoTriggerConfig", "description": "Configuration detail of a trigger. Next available id: 22", "type": "object" }, "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer": { "description": "Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.", "type": "object", "id": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearer", "properties": { "clientKey": { "description": "Optional. Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`.", "$ref": "GoogleCloudConnectorsV1Secret" }, "jwtClaims": { "description": "Optional. JwtClaims providers fields to generate the token.", "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims" } } }, "GoogleCloudIntegrationsV1alphaSfdcChannel": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaSfdcChannel", "properties": { "deleteTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Time when the channel was deleted. Empty if not deleted." }, "isActive": { "readOnly": true, "description": "Output only. Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.", "type": "boolean" }, "displayName": { "description": "Optional. Client level unique name/alias to easily reference a channel.", "type": "string" }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. Time when the channel is created" }, "name": { "type": "string", "description": "Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}." }, "description": { "description": "Optional. The description for this channel", "type": "string" }, "updateTime": { "format": "google-datetime", "description": "Output only. Time when the channel was last updated", "type": "string", "readOnly": true }, "channelTopic": { "description": "Required. The Channel topic defined by salesforce once an channel is opened", "type": "string" }, "lastReplayId": { "description": "Output only. Last sfdc messsage replay id for channel", "type": "string", "readOnly": true } }, "description": "The SfdcChannel that points to a CDC or Platform Event Channel." }, "GoogleCloudIntegrationsV1alphaUnshareTemplateRequest": { "properties": { "resourceNames": { "items": { "type": "string" }, "description": "Optional. Project name resources to unshare the template. The project names is expected in resource format Ex: projects/{project-number}", "type": "array" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaUnshareTemplateRequest", "description": "Request to Unshare template" }, "GoogleCloudConnectorsV1EventingConfig": { "type": "object", "description": "Eventing Configuration of a connection next: 21", "properties": { "globalEventFilter": { "description": "Optional. Filter to be applied on the events to be received by the connection.", "type": "string" }, "enrichmentConfig": { "description": "Optional. Data enrichment configuration.", "$ref": "GoogleCloudConnectorsV1EnrichmentConfig" }, "allowedEventTypes": { "description": "Optional. List of allowed event types for the connection.", "type": "array", "items": { "type": "string" } }, "privateConnectivityAllowlistedProjects": { "type": "array", "description": "Optional. List of projects to be allowlisted for the service attachment created in the tenant project for eventing ingress.", "items": { "type": "string" } }, "enrichmentEnabled": { "description": "Optional. Enrichment Enabled.", "type": "boolean" }, "proxyDestinationConfig": { "$ref": "GoogleCloudConnectorsV1DestinationConfig", "description": "Optional. Proxy for Eventing auto-registration." }, "registrationDestinationConfig": { "$ref": "GoogleCloudConnectorsV1DestinationConfig", "description": "Optional. Registration endpoint for auto registration." }, "deadLetterConfig": { "$ref": "GoogleCloudConnectorsV1EventingConfigDeadLetterConfig", "description": "Optional. Dead letter configuration for eventing of a connection." }, "additionalVariables": { "description": "Optional. Additional eventing related field values", "type": "array", "items": { "$ref": "GoogleCloudConnectorsV1ConfigVariable" } }, "listenerAuthConfig": { "description": "Optional. Auth details for the event listener.", "$ref": "GoogleCloudConnectorsV1AuthConfig" }, "authConfig": { "description": "Optional. Auth details for the webhook adapter.", "$ref": "GoogleCloudConnectorsV1AuthConfig" }, "sslConfig": { "description": "Optional. Ssl config of a connection", "$ref": "GoogleCloudConnectorsV1SslConfig" }, "privateConnectivityEnabled": { "description": "Optional. Private Connectivity Enabled.", "type": "boolean" }, "eventsListenerIngressEndpoint": { "readOnly": true, "description": "Output only. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.", "type": "string" } }, "id": "GoogleCloudConnectorsV1EventingConfig" }, "GoogleCloudIntegrationsV1alphaAuthToken": { "type": "object", "description": "The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header.", "id": "GoogleCloudIntegrationsV1alphaAuthToken", "properties": { "token": { "type": "string", "description": "The token for the auth type." }, "type": { "description": "Authentication type, e.g. \"Basic\", \"Bearer\", etc.", "type": "string" } } }, "GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse": { "type": "object", "properties": { "integrationVersion": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "description": "Version after the lock is acquired by the new user." } }, "description": "Response for TakeoverEditLock.", "id": "GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse" }, "GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata": { "type": "object", "description": "Metadata of runtime connection schema.", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "List of actions." }, "entities": { "items": { "type": "string" }, "description": "List of entity names.", "type": "array" } }, "id": "GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata" }, "EnterpriseCrmEventbusProtoToken": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "id": "EnterpriseCrmEventbusProtoToken" }, "EnterpriseCrmEventbusProtoScatterResponse": { "id": "EnterpriseCrmEventbusProtoScatterResponse", "properties": { "responseParams": { "items": { "$ref": "EnterpriseCrmEventbusProtoParameterEntry" }, "description": "A list of all the response parameters in the aggregtorMap stored with the remapped key.", "type": "array" }, "scatterElement": { "description": "The element that was scattered for this execution.", "$ref": "EnterpriseCrmEventbusProtoParameterValueType" }, "errorMsg": { "description": "The error message of the failure if applicable.", "type": "string" }, "isSuccessful": { "description": "If execution is sync, this is true if the execution passed and false if it failed. If the execution is async, this is true if the WF was fired off successfully, and false if it failed to execute. The success or failure of the subworkflows executed are not captured.", "type": "boolean" }, "executionIds": { "type": "array", "description": "The execution ids of each Subworkflow fired by this scatter.", "items": { "type": "string" } } }, "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter": { "id": "EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter", "type": "object", "properties": { "objectValue": { "type": "string", "format": "byte" } } }, "GoogleCloudIntegrationsV1alphaErrorCatcherConfig": { "description": "Configuration detail of a error catch task", "properties": { "errorCatcherId": { "description": "Required. An error catcher id is string representation for the error catcher config. Within a workflow, error_catcher_id uniquely identifies an error catcher config among all error catcher configs for the workflow", "type": "string" }, "position": { "description": "Optional. Informs the front-end application where to draw this error catcher config on the UI.", "$ref": "GoogleCloudIntegrationsV1alphaCoordinate" }, "description": { "description": "Optional. User-provided description intended to give more business context about the error catcher config.", "type": "string" }, "errorCatcherNumber": { "description": "Required. A number to uniquely identify each error catcher config within the workflow on UI.", "type": "string" }, "label": { "type": "string", "description": "Optional. The user created label for a particular error catcher. Optional." }, "startErrorTasks": { "description": "Required. The set of start tasks that are to be executed for the error catch flow", "items": { "$ref": "GoogleCloudIntegrationsV1alphaNextTask" }, "type": "array" } }, "id": "GoogleCloudIntegrationsV1alphaErrorCatcherConfig", "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray": { "id": "EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray", "type": "object", "properties": { "doubleValues": { "type": "array", "items": { "format": "double", "type": "number" } } } }, "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse", "description": "Response for UploadIntegrationVersion.", "properties": { "integrationVersion": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "description": "The uploaded integration." } } }, "EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot": { "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot", "properties": { "eventExecutionSnapshotMetadata": { "$ref": "EnterpriseCrmEventbusProtoEventExecutionSnapshotEventExecutionSnapshotMetadata" }, "diffParams": { "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "description": "The parameters in Event object that differs from last snapshot." }, "taskName": { "description": "The task name associated with this snapshot. Could be empty.", "type": "string", "deprecated": true }, "snapshotTime": { "description": "Indicates when this snapshot is taken.", "type": "string", "format": "int64" }, "conditionResults": { "description": "All of the computed conditions that been calculated.", "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoConditionResult" } }, "taskExecutionDetails": { "items": { "$ref": "EnterpriseCrmEventbusProtoTaskExecutionDetails" }, "type": "array", "description": "All of the task execution details at the given point of time." }, "eventExecutionInfoId": { "description": "Points to the event execution info this snapshot belongs to.", "type": "string" }, "eventExecutionSnapshotId": { "type": "string", "description": "Auto-generated. Used as primary key for EventExecutionSnapshots table." }, "checkpointTaskNumber": { "description": "Indicates \"right after which checkpoint task's execution\" this snapshot is taken.", "type": "string" }, "eventParams": { "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "description": "The parameters in Event object." } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse": { "description": "Response to list SfdcChannels.", "id": "GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "The token used to retrieve the next page of results." }, "sfdcChannels": { "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "description": "The list of SfdcChannels retrieved." } } }, "EnterpriseCrmEventbusProtoCloudSchedulerConfig": { "description": "Cloud Scheduler Trigger configuration", "type": "object", "id": "EnterpriseCrmEventbusProtoCloudSchedulerConfig", "properties": { "serviceAccountEmail": { "type": "string", "description": "Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time" }, "errorMessage": { "description": "Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations", "type": "string" }, "location": { "description": "Required. The location where associated cloud scheduler job will be created", "type": "string" }, "cronTab": { "type": "string", "description": "Required. The cron tab of cloud scheduler trigger." } } }, "GoogleCloudConnectorsV1EnrichmentConfig": { "properties": { "appendAcl": { "type": "boolean", "description": "Optional. Append ACL to the event." } }, "id": "GoogleCloudConnectorsV1EnrichmentConfig", "type": "object", "description": "Data enrichment configuration." }, "GoogleCloudIntegrationsV1alphaNextTask": { "description": "The task that is next in line to be executed, if the condition specified evaluated to true.", "type": "object", "id": "GoogleCloudIntegrationsV1alphaNextTask", "properties": { "displayName": { "description": "User-provided label that is attached to this edge in the UI.", "type": "string" }, "taskId": { "type": "string", "description": "Task number of the next task." }, "description": { "description": "User-provided description intended to give additional business context about the task.", "type": "string" }, "taskConfigId": { "description": "ID of the next task.", "type": "string" }, "condition": { "description": "Standard filter expression for this task to become an eligible next task.", "type": "string" } } }, "GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse": { "description": "The response for executing an integration.", "id": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse", "type": "object", "properties": { "parameterEntries": { "description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", "deprecated": true, "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" }, "type": "array" }, "executionId": { "description": "The id of the execution corresponding to this run of integration.", "type": "string" }, "outputParameters": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "description": "OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.", "type": "object" }, "eventParameters": { "deprecated": true, "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "description": "Details for the integration that were executed." }, "parameters": { "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, "description": "Optional. OUTPUT parameters from integration execution.", "type": "object" }, "executionFailed": { "deprecated": true, "type": "boolean", "description": "Is true if any execution in the integration failed. False otherwise." } } }, "EnterpriseCrmEventbusProtoConnectorsConnection": { "type": "object", "id": "EnterpriseCrmEventbusProtoConnectorsConnection", "properties": { "serviceName": { "description": "Service name Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}", "type": "string" }, "connectorVersion": { "type": "string", "description": "Connector version Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}" }, "connectionName": { "description": "Connection name Format: projects/{project}/locations/{location}/connections/{connection}", "type": "string" }, "host": { "description": "The name of the Hostname of the Service Directory service with TLS if used.", "type": "string" } } }, "EnterpriseCrmEventbusProtoNodeIdentifier": { "description": "Represents a node identifier (type + id). Next highest id: 3", "properties": { "elementType": { "type": "string", "enum": [ "UNKNOWN_TYPE", "TASK_CONFIG", "TRIGGER_CONFIG" ], "enumDescriptions": [ "", "", "" ], "description": "Destination node where the edge ends. It can only be a task config." }, "elementIdentifier": { "type": "string", "description": "Configuration of the edge." } }, "id": "EnterpriseCrmEventbusProtoNodeIdentifier", "type": "object" }, "EnterpriseCrmEventbusProtoConditionResult": { "id": "EnterpriseCrmEventbusProtoConditionResult", "properties": { "result": { "description": "the result comes out after evaluate the combined condition. True if there's no combined condition specified.", "type": "boolean" }, "nextTaskNumber": { "description": "the next task number.", "type": "string" }, "currentTaskNumber": { "description": "the current task number.", "type": "string" } }, "type": "object", "description": "Contains the combined condition calculation results." }, "EnterpriseCrmEventbusProtoIntArray": { "type": "object", "id": "EnterpriseCrmEventbusProtoIntArray", "properties": { "values": { "type": "array", "items": { "format": "int64", "type": "string" } } } }, "GoogleCloudIntegrationsV1alphaListExecutionsResponse": { "description": "Response for listing the integration execution data.", "id": "GoogleCloudIntegrationsV1alphaListExecutionsResponse", "properties": { "nextPageToken": { "description": "The token used to retrieve the next page results.", "type": "string" }, "executionInfos": { "deprecated": true, "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo" }, "description": "Required. The detailed information of requested executions.", "type": "array" }, "executions": { "description": "The detailed information of requested executions", "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaExecution" } } }, "type": "object" }, "EnterpriseCrmEventbusProtoDoubleArrayFunction": { "type": "object", "id": "EnterpriseCrmEventbusProtoDoubleArrayFunction", "properties": { "functionName": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNSPECIFIED", "GET", "APPEND", "SIZE", "SUM", "AVG", "MAX", "MIN", "TO_SET", "APPEND_ALL", "TO_JSON", "SET", "REMOVE", "REMOVE_AT", "CONTAINS", "FOR_EACH", "FILTER" ] } } }, "GoogleCloudConnectorsV1SslConfig": { "properties": { "clientPrivateKey": { "description": "Optional. Client Private Key", "$ref": "GoogleCloudConnectorsV1Secret" }, "clientPrivateKeyPass": { "$ref": "GoogleCloudConnectorsV1Secret", "description": "Optional. Secret containing the passphrase protecting the Client Private Key" }, "serverCertType": { "description": "Optional. Type of Server Cert (PEM/JKS/.. etc.)", "enumDescriptions": [ "Cert type unspecified.", "Privacy Enhanced Mail (PEM) Type" ], "type": "string", "enum": [ "CERT_TYPE_UNSPECIFIED", "PEM" ] }, "clientCertType": { "enumDescriptions": [ "Cert type unspecified.", "Privacy Enhanced Mail (PEM) Type" ], "description": "Optional. Type of Client Cert (PEM/JKS/.. etc.)", "type": "string", "enum": [ "CERT_TYPE_UNSPECIFIED", "PEM" ] }, "trustModel": { "description": "Optional. Trust Model of the SSL connection", "enumDescriptions": [ "Public Trust Model. Takes the Default Java trust store.", "Private Trust Model. Takes custom/private trust store.", "Insecure Trust Model. Accept all certificates." ], "type": "string", "enum": [ "PUBLIC", "PRIVATE", "INSECURE" ] }, "useSsl": { "description": "Optional. Bool for enabling SSL", "type": "boolean" }, "privateServerCertificate": { "description": "Optional. Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.", "$ref": "GoogleCloudConnectorsV1Secret" }, "additionalVariables": { "description": "Optional. Additional SSL related field values", "items": { "$ref": "GoogleCloudConnectorsV1ConfigVariable" }, "type": "array" }, "type": { "type": "string", "enum": [ "SSL_TYPE_UNSPECIFIED", "TLS", "MTLS" ], "description": "Optional. Controls the ssl type for the given connector version.", "enumDescriptions": [ "No SSL configuration required.", "TLS Handshake", "mutual TLS (MTLS) Handshake" ] }, "clientCertificate": { "$ref": "GoogleCloudConnectorsV1Secret", "description": "Optional. Client Certificate" } }, "type": "object", "description": "SSL Configuration of a connection", "id": "GoogleCloudConnectorsV1SslConfig" }, "GoogleCloudIntegrationsV1alphaTemplateComponent": { "type": "object", "description": "Define the components that are present in a template.", "id": "GoogleCloudIntegrationsV1alphaTemplateComponent", "properties": { "name": { "description": "Optional. Name of the component.", "type": "string" }, "type": { "description": "Optional. Type of the component.", "type": "string", "enum": [ "TYPE_UNSPECIFIED", "TRIGGER", "TASK", "CONNECTOR" ], "enumDescriptions": [ "Component type is unspecified", "Trigger component", "Task component", "Connector component" ] } } }, "GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig": { "properties": { "customMessage": { "type": "string", "description": "Information to provide for recipients." }, "expiration": { "$ref": "GoogleCloudIntegrationsV1alphaSuspensionApprovalExpiration", "description": "Indicates the next steps when no external actions happen on the suspension." }, "emailAddresses": { "description": "Email addresses to send approval request to.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "description": "Configurations for approving the Suspension.", "id": "GoogleCloudIntegrationsV1alphaSuspensionApprovalConfig" }, "EnterpriseCrmEventbusProtoSuspensionAuthPermissions": { "properties": { "gaiaIdentity": { "description": "Represents a Gaia identity for a person or service account.", "$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity" }, "googleGroup": { "$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity" }, "mdbGroup": { "type": "string" }, "loasRole": { "type": "string" } }, "id": "EnterpriseCrmEventbusProtoSuspensionAuthPermissions", "description": "LINT.IfChange", "type": "object" }, "EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit": { "properties": { "resolvedByCpi": { "type": "string" }, "timestamp": { "type": "string", "format": "google-datetime" }, "resolvedBy": { "type": "string" } }, "type": "object", "id": "EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit" }, "GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials": { "type": "object", "properties": { "requestType": { "description": "Represent how to pass parameters to fetch access token", "type": "string", "enum": [ "REQUEST_TYPE_UNSPECIFIED", "REQUEST_BODY", "QUERY_PARAMETERS", "ENCODED_HEADER" ], "enumDescriptions": [ "Unspecified request type", "To pass all the parameters in post body.", "To pass all the parameters as a part of query parameter.", "To pass client id and client secret as base 64 encoding of client_id:client_password and rest parameters in post body." ] }, "scope": { "description": "A space-delimited list of requested scope permissions.", "type": "string" }, "username": { "description": "The user's username.", "type": "string" }, "password": { "type": "string", "description": "The user's password." }, "tokenParams": { "$ref": "GoogleCloudIntegrationsV1alphaParameterMap", "description": "Token parameters for the auth request." }, "tokenEndpoint": { "type": "string", "description": "The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token." }, "clientId": { "type": "string", "description": "The client's ID." }, "accessToken": { "description": "Access token fetched from the authorization server.", "$ref": "GoogleCloudIntegrationsV1alphaAccessToken" }, "clientSecret": { "description": "The client's secret.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentials", "description": "For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token." }, "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry": { "id": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry", "type": "object", "properties": { "producer": { "type": "string" }, "inOutType": { "type": "string", "enum": [ "IN_OUT_TYPE_UNSPECIFIED", "IN", "OUT", "IN_OUT" ], "enumDescriptions": [ "", "Input parameters for the workflow. EventBus validates that these parameters exist in the workflows before execution.", "Output Parameters for the workflow. EventBus will only return the workflow parameters tagged with OUT in the response back.", "Input or Output Parameters. These can be used as both input and output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response." ], "description": "Specifies the input/output type for the parameter." }, "jsonSchema": { "type": "string", "description": "This schema will be used to validate runtime JSON-typed values of this parameter." }, "name": { "description": "The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is \"foo.bar.myName\", then the name would be \"myName\".", "type": "string" }, "containsLargeData": { "description": "Indicates whether this variable contains large data and need to be uploaded to Cloud Storage.", "type": "boolean" }, "protoDefName": { "description": "The name of the protobuf type if the parameter has a protobuf data type.", "type": "string" }, "key": { "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.", "type": "string" }, "producedBy": { "$ref": "EnterpriseCrmEventbusProtoNodeIdentifier", "description": "The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param." }, "description": { "description": "Optional. The description about the parameter", "type": "string" }, "attributes": { "description": "Metadata information about the parameters.", "$ref": "EnterpriseCrmEventbusProtoAttributes" }, "isTransient": { "type": "boolean", "description": "Whether this parameter is a transient parameter." }, "dataType": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "", "", "" ], "description": "The data type of the parameter.", "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "PROTO_VALUE", "SERIALIZED_OBJECT_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "PROTO_ARRAY", "PROTO_ENUM", "BOOLEAN_ARRAY", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY", "NON_SERIALIZABLE_OBJECT", "JSON_VALUE" ] }, "protoDefPath": { "description": "If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be \"enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry\".", "type": "string" }, "defaultValue": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", "description": "Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." }, "required": { "type": "boolean" }, "children": { "description": "Child parameters nested within this parameter. This field only applies to protobuf parameters", "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry" }, "type": "array" } } }, "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails": { "properties": { "integration": { "description": "Required. Name of the sub integration which would be created via templates.", "type": "string" }, "integrationDescription": { "description": "Optional. Description of the sub integration which would be created via templates.", "type": "string" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails", "description": "Sub Integration which would be created via templates." }, "GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse": { "properties": { "executeTestCaseResponses": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse" }, "type": "array", "description": "Results of each execution of test cases in an integration version." } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse", "description": "Response for ExecuteTestCases." }, "EnterpriseCrmFrontendsEventbusProtoRollbackStrategy": { "description": "Next available id: 4", "id": "EnterpriseCrmFrontendsEventbusProtoRollbackStrategy", "type": "object", "properties": { "parameters": { "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "description": "Optional. The customized parameters the user can pass to this task." }, "rollbackTaskImplementationClassName": { "type": "string", "description": "Required. This is the name of the task that needs to be executed upon rollback of this task." }, "taskNumbersToRollback": { "description": "Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.", "items": { "type": "string" }, "type": "array" } } }, "EnterpriseCrmEventbusProtoWorkflowAlertConfig": { "description": "Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.", "id": "EnterpriseCrmEventbusProtoWorkflowAlertConfig", "type": "object", "properties": { "warningEnumList": { "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" }, "playbookUrl": { "description": "Link to a playbook for resolving the issue that triggered this alert.", "type": "string" }, "metricType": { "enumDescriptions": [ "The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.", "Specifies alerting on the rate of errors for the enclosing workflow.", "Specifies alerting on the rate of warnings for the enclosing workflow. Warnings use the same enum values as errors.", "Specifies alerting on the rate of errors for any task in the enclosing workflow.", "Specifies alerting on the rate of warnings for any task in the enclosing workflow.", "Specifies alerting on the rate of executions over all tasks in the enclosing workflow.", "Specifies alerting on the number of events executed in the given aggregation_period.", "Specifies alerting on the average duration of executions for this workflow.", "Specifies alerting on the duration value of a particular percentile of workflow executions. E.g. If 10% or more of the workflow executions have durations above 5 seconds, alert.", "Specifies alerting on the average duration of any task in the enclosing workflow,", "Specifies alerting on the duration value of a particular percentile of any task executions within the enclosing workflow. E.g. If 10% or more of the task executions in the workflow have durations above 5 seconds, alert." ], "type": "string", "enum": [ "METRIC_TYPE_UNSPECIFIED", "EVENT_ERROR_RATE", "EVENT_WARNING_RATE", "TASK_ERROR_RATE", "TASK_WARNING_RATE", "TASK_RATE", "EVENT_RATE", "EVENT_AVERAGE_DURATION", "EVENT_PERCENTILE_DURATION", "TASK_AVERAGE_DURATION", "TASK_PERCENTILE_DURATION" ] }, "thresholdValue": { "description": "The metric value, above or below which the alert should be triggered.", "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue" }, "alertName": { "description": "A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.", "type": "string" }, "thresholdType": { "description": "The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.", "enumDescriptions": [ "", "Note that this field will only trigger alerts if the workflow specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that `aggregation_period` for this alert configuration must be less than 24 hours.", "" ], "type": "string", "enum": [ "UNSPECIFIED_THRESHOLD_TYPE", "EXPECTED_MIN", "EXPECTED_MAX" ] }, "alertDisabled": { "description": "Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.", "type": "boolean" }, "onlyFinalAttempt": { "type": "boolean", "description": "For either events or tasks, depending on the type of alert, count only final attempts, not retries." }, "clientId": { "type": "string", "description": "Client associated with this alert configuration." }, "numAggregationPeriods": { "format": "int32", "description": "For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.", "type": "integer" }, "durationThresholdMs": { "format": "int64", "description": "Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.", "type": "string" }, "aggregationPeriod": { "type": "string", "description": "For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours." }, "errorEnumList": { "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" } } }, "GoogleCloudIntegrationsV1alphaSerializedFile": { "description": "To store string representation of Integration file.", "id": "GoogleCloudIntegrationsV1alphaSerializedFile", "properties": { "file": { "enumDescriptions": [ "Default value.", "Integration file.", "Integration Config variables." ], "type": "string", "enum": [ "INTEGRATION_FILE_UNSPECIFIED", "INTEGRATION", "INTEGRATION_CONFIG_VARIABLES" ], "description": "File information like Integration version, Integration Config variables etc." }, "content": { "type": "string", "description": "String representation of the file content." } }, "type": "object" }, "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats": { "type": "object", "properties": { "endTime": { "format": "int64", "description": "The end time of the event execution for current attempt.", "type": "string" }, "startTime": { "description": "The start time of the event execution for current attempt. This could be in the future if it's been scheduled.", "format": "int64", "type": "string" } }, "id": "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats" }, "GoogleCloudIntegrationsV1alphaFailurePolicy": { "properties": { "condition": { "description": "Optional. The string condition that will be evaluated to determine if the task should be retried with this failure policy.", "type": "string" }, "maxRetries": { "format": "int32", "type": "integer", "description": "Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed." }, "retryStrategy": { "description": "Defines what happens to the task upon failure.", "enumDescriptions": [ "UNSPECIFIED.", "Ignores the failure of this task. The rest of the integration will be executed Assuming this task succeeded.", "Causes a permanent failure of the task. However, if the last task(s) of event was successfully completed despite the failure of this task, it has no impact on the integration.", "Causes a permanent failure of the event. It is different from NONE because this will mark the event as FAILED by shutting down the event execution.", "The task will be retried from the failed task onwards after a fixed delay. A max-retry count is required to be specified with this strategy. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. max_retries and interval_in_seconds must be specified.", "The task will be retried from the failed task onwards after a fixed delay that linearly increases with each retry attempt. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. max_retries and interval_in_seconds must be specified.", "The task will be retried after an exponentially increasing period of time with each failure. A jitter is added to each exponential interval so that concurrently failing tasks of the same type do not end up retrying after the exact same exponential interval. A max-retry count is required to be specified with this strategy. `max_retries` and `interval_in_seconds` must be specified.", "The entire integration will be restarted with the initial parameters that were set when the event was fired. A max-retry count is required to be specified with this strategy. `max_retries` and `interval_in_seconds` must be specified." ], "type": "string", "enum": [ "RETRY_STRATEGY_UNSPECIFIED", "IGNORE", "NONE", "FATAL", "FIXED_INTERVAL", "LINEAR_BACKOFF", "EXPONENTIAL_BACKOFF", "RESTART_INTEGRATION_WITH_BACKOFF" ] }, "intervalTime": { "format": "google-datetime", "type": "string", "description": "Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff." } }, "description": "Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied).", "type": "object", "id": "GoogleCloudIntegrationsV1alphaFailurePolicy" }, "GoogleCloudIntegrationsV1alphaAccessToken": { "description": "The access token represents the authorization of a specific application to access specific parts of a user’s data.", "id": "GoogleCloudIntegrationsV1alphaAccessToken", "type": "object", "properties": { "refreshTokenExpireTime": { "type": "string", "description": "The approximate time until the refresh token retrieved is valid.", "format": "google-datetime" }, "accessToken": { "description": "The access token encapsulating the security identity of a process or thread.", "type": "string" }, "refreshToken": { "type": "string", "description": "If the access token will expire, use the refresh token to obtain another access token." }, "tokenType": { "type": "string", "description": "Only support \"bearer\" token in v1 as bearer token is the predominant type used with OAuth 2.0." }, "accessTokenExpireTime": { "format": "google-datetime", "type": "string", "description": "Required. The approximate time until the access token retrieved is valid." } } }, "EnterpriseCrmEventbusProtoAttributes": { "type": "object", "id": "EnterpriseCrmEventbusProtoAttributes", "description": "Attributes are additional options that can be associated with each event property. For more information, see", "properties": { "masked": { "description": "True if this workflow parameter should be masked in the logs", "type": "boolean" }, "isRequired": { "description": "Required for event execution. The validation will be done by the event bus when the event is triggered.", "type": "boolean" }, "logSettings": { "description": "See", "$ref": "EnterpriseCrmEventbusProtoLogSettings" }, "dataType": { "description": "Things like URL, Email, Currency, Timestamp (rather than string, int64...)", "enumDescriptions": [ "", "", "", "", "", "Domain is a web url string with one top-level private domain and a suffix (for example: google.com, walmart.com)" ], "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "EMAIL", "URL", "CURRENCY", "TIMESTAMP", "DOMAIN_NAME" ] }, "isSearchable": { "type": "boolean", "description": "Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.", "deprecated": true }, "searchable": { "enumDescriptions": [ "", "If yes, the parameter key and value will be full-text indexed. In a proto, this value will propagate to all children whose searchable is unspecified.", "If no, the parameter key and value will not be full-text indexed. In a proto, this value will propagate to all children whose searchable is unspecified." ], "type": "string", "enum": [ "UNSPECIFIED", "YES", "NO" ] }, "readOnly": { "type": "boolean", "description": "Used to indicate if the ParameterEntry is a read only field or not." }, "taskVisibility": { "description": "List of tasks that can view this property, if empty then all.", "items": { "type": "string" }, "type": "array" }, "defaultValue": { "$ref": "EnterpriseCrmEventbusProtoValueType", "description": "Used to define defaults." } } }, "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest", "description": "The request for testing an integration.", "properties": { "inputParameters": { "description": "Optional. Input parameters used during integration execution.", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, "type": "object" }, "configParameters": { "description": "Optional. Config parameters used during integration execution.", "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" }, "deadlineSecondsTime": { "description": "Optional. custom deadline of the rpc", "type": "string", "format": "google-datetime" }, "integrationVersion": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "description": "Required. integration config to execute the workflow" }, "parameters": { "description": "Optional. Passed in as parameters to each integration execution.", "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "deprecated": true }, "triggerId": { "type": "string", "description": "Required. The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks." }, "clientId": { "type": "string", "description": "Required. This is used to identify the client on whose behalf the event will be executed." }, "testMode": { "description": "Optional. Can be specified in the event request, otherwise false (default). If true, enables tasks with condition \"test_mode = true\". If false, disables tasks with condition \"test_mode = true\" if global test mode (set by platform) is also false {@link EventBusConfig}.", "type": "boolean" }, "credentialMode": { "type": "string", "enum": [ "CREDENTIAL_MODE_UNSPECIFIED", "CREDENTIAL_MODE_CURRENT", "CREDENTIAL_MODE_HARDENED" ], "description": "Optional. The credential flow to run the test under. Applies to synchronous tests only. When unset, the default depends on when the test runs: before the EUC hardening cutover it is `CREDENTIAL_MODE_CURRENT`; from the cutover on it is `CREDENTIAL_MODE_HARDENED`, whatever the integration's stored disposition. Where the hardened flow cannot be evaluated, an unset mode runs `CREDENTIAL_MODE_CURRENT` instead of failing. The response's `credential_mode` reports the mode that ran.", "enumDescriptions": [ "Resolves based on when the test runs; see `TestIntegrationsRequest.credential_mode`.", "The flow production runs for this integration today.", "The flow an integration created after the EUC hardening cutover runs. Covers this integration's own tasks; a sub-integration it calls runs under its own stored disposition. When requested explicitly, fails with `FAILED_PRECONDITION` where the hardened flow cannot be evaluated, and with `UNIMPLEMENTED` for asynchronous tests." ] }, "asyncExecution": { "description": "Optional. Runs the test asynchronously, by enqueueing it through the real execution queue under `trigger_id` instead of running the task graph inline. Default `false`, which preserves the existing synchronous behavior. The enqueued request carries no caller identity, so it is drained under the integration's run-as service account, exactly as a real Cloud Scheduler, cron, Pub/Sub, Salesforce or connector fire would be. That is the only way to verify the credential path an asynchronous trigger actually takes; a synchronous test always carries the caller's own credential and so exercises the opposite branch. When `true`: * The version named by `integration_version.name` runs. A name ending in `/versions/{version}` runs that exact version, published or draft; a name without one runs the published (`ACTIVE`) version on the trigger. Either way the integration is resolved from storage, so `integration_version` must carry only `name`; supplying any other field is rejected, rather than silently running something other than what was passed. * A draft is validated before it is enqueued, including the check that the caller may act as the integration's run-as service account. Testing a draft therefore fails fast on a configuration a publish would reject. * The response carries `execution_id` only. `execution_failed`, `event_parameters`, `parameters` and `parameter_entries` describe a finished run and are left unset, because nothing has run yet. In particular, do not read `execution_failed` as a pass signal. * The run is real, with real side effects, quota and concurrency. No actual Pub/Sub push or Cloud Scheduler tick occurs; only the enqueue is simulated, which does not change the credential path.", "type": "boolean" } } }, "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest": { "id": "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest", "description": "Request for [Suspensions.ResolveSuspensions].", "type": "object", "properties": { "suspension": { "description": "Suspension, containing the event_execution_info_id, task_id, and state to set on the corresponding suspension record.", "$ref": "GoogleCloudIntegrationsV1alphaSuspension" } } }, "GoogleCloudConnectorsV1Secret": { "id": "GoogleCloudConnectorsV1Secret", "type": "object", "description": "Secret provides a reference to entries in Secret Manager.", "properties": { "secretVersion": { "description": "Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.", "type": "string" } } }, "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse": { "properties": { "content": { "description": "String representation of the template.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse", "description": "Response for DownloadTemplate.", "type": "object" }, "GoogleCloudIntegrationsV1alphaExecutionDetails": { "description": "Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics.", "id": "GoogleCloudIntegrationsV1alphaExecutionDetails", "properties": { "executionSnapshots": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaExecutionSnapshot" }, "description": "List of snapshots taken during the execution.", "type": "array" }, "eventExecutionSnapshotsSize": { "type": "string", "format": "int64", "description": "Total size of all event_execution_snapshots for an execution" }, "attemptStats": { "description": "List of Start and end time of the execution attempts.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaAttemptStats" }, "type": "array" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "PENDING", "PROCESSING", "SUCCEEDED", "FAILED", "CANCELLED", "RETRY_ON_HOLD", "SUSPENDED" ], "description": "Status of the execution.", "enumDescriptions": [ "Default.", "Execution is scheduled and awaiting to be triggered.", "Execution is processing.", "Execution successfully finished. There's no more change after this state.", "Execution failed. There's no more change after this state.", "Execution canceled by user. There's no more change after this state.", "Execution failed and waiting for retry.", "Execution suspended and waiting for manual intervention." ] } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse": { "id": "GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse", "description": "Response for listing RuntimeActionSchemas for a specific Connection.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "Next page token." }, "runtimeActionSchemas": { "description": "Runtime action schemas.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaRuntimeActionSchema" }, "type": "array" } } }, "EnterpriseCrmEventbusProtoCombinedCondition": { "deprecated": true, "type": "object", "description": "This message recursively combines constituent conditions using logical AND.", "id": "EnterpriseCrmEventbusProtoCombinedCondition", "properties": { "conditions": { "type": "array", "description": "A set of individual constituent conditions.", "items": { "$ref": "EnterpriseCrmEventbusProtoCondition" } } } }, "GoogleCloudConnectorsV1AdminFiltersStringListValues": { "type": "object", "description": "StringListValues is a message to store a list of string values.", "properties": { "listValues": { "items": { "type": "string" }, "description": "Required. The list of string values.", "type": "array" } }, "id": "GoogleCloudConnectorsV1AdminFiltersStringListValues" }, "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged": { "description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details.", "type": "object", "id": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged", "properties": { "scopes": { "type": "array", "description": "Required. Scopes the connection will request when the user performs the auth code flow.", "items": { "type": "string" } }, "authCode": { "type": "string", "description": "Optional. Authorization code to be exchanged for access and refresh tokens." }, "redirectUri": { "type": "string", "description": "Optional. Redirect URI to be provided during the auth code exchange." } } }, "EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam": { "properties": { "scope": { "description": "A space-delimited list of requested scope permissions.", "type": "string" }, "allowedServiceAccountInContext": { "type": "boolean" }, "authConfigId": { "description": "UUID of the AuthConfig.", "type": "string" }, "allowedCredentialTypes": { "items": { "type": "string", "enum": [ "CREDENTIAL_TYPE_UNSPECIFIED", "USERNAME_AND_PASSWORD", "API_KEY", "OAUTH2_AUTHORIZATION_CODE", "OAUTH2_IMPLICIT", "OAUTH2_CLIENT_CREDENTIALS", "OAUTH2_RESOURCE_OWNER_CREDENTIALS", "JWT", "AUTH_TOKEN", "SERVICE_ACCOUNT", "CLIENT_CERTIFICATE_ONLY", "OIDC_TOKEN" ], "enumDescriptions": [ "", "Regular username/password pair.", "API key.", "OAuth 2.0 Authorization Code Grant Type.", "OAuth 2.0 Implicit Grant Type.", "OAuth 2.0 Client Credentials Grant Type.", "OAuth 2.0 Resource Owner Credentials Grant Type.", "JWT Token.", "Auth Token, e.g. bearer token.", "Service Account which can be used to generate token for authentication.", "Client Certificate only.", "Google OIDC ID Token" ] }, "type": "array", "description": "Defines the credential types to be supported as Task may restrict specific types to use, e.g. Cloud SQL Task will use username/password type only." }, "useServiceAccountInContext": { "type": "boolean" } }, "id": "EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam", "type": "object" }, "GoogleCloudIntegrationsV1alphaParameterMapField": { "id": "GoogleCloudIntegrationsV1alphaParameterMapField", "properties": { "referenceKey": { "description": "Referencing one of the Integration variables.", "type": "string" }, "literalValue": { "description": "Passing a literal value.", "$ref": "GoogleCloudIntegrationsV1alphaValueType" } }, "description": "Field represents either the key or value in an entry.", "type": "object" }, "GoogleCloudIntegrationsV1alphaSearchTemplatesResponse": { "properties": { "templates": { "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaTemplate" }, "description": "List of templates retrieved." }, "nextPageToken": { "description": "The token used to retrieve the next page results.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaSearchTemplatesResponse", "type": "object", "description": "Response for a request to search templates" }, "EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails": { "properties": { "networkAddress": { "description": "The network address (aka. bns address) that indicates where the event executor is running.", "type": "string" }, "eventAttemptStats": { "items": { "$ref": "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats" }, "type": "array" }, "eventExecutionSnapshot": { "type": "array", "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoEventExecutionSnapshot" }, "description": "After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible." }, "nextExecutionTime": { "type": "string", "format": "int64", "description": "Next scheduled execution time in case the execution status was RETRY_ON_HOLD." }, "eventExecutionState": { "type": "string", "enum": [ "UNSPECIFIED", "ON_HOLD", "IN_PROCESS", "SUCCEEDED", "FAILED", "CANCELED", "RETRY_ON_HOLD", "SUSPENDED" ], "description": "The execution state of this event.", "enumDescriptions": [ "", "Event is received and waiting for the execution. This happens when firing the event via \"postToQueue\" or \"schedule\".", "Event is under processing.", "Event execution successfully finished. There's no more change after this state.", "Event execution failed. There's no more change after this state.", "Event execution canceled by user. There's no more change after this state.", "Event execution failed and waiting for retry.", "Event execution suspended and waiting for manual intervention." ] }, "logFilePath": { "description": "The log file path (aka. cns address) for this event.", "type": "string" }, "ryeLockUnheldCount": { "format": "int32", "type": "integer", "description": "Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/" }, "cancelReason": { "description": "If the execution is manually canceled, this field will contain the reason for cancellation.", "type": "string" }, "eventExecutionSnapshotsSize": { "format": "int64", "type": "string", "description": "Total size of all event_execution_snapshots for an execution" }, "eventRetriesFromBeginningCount": { "format": "int32", "description": "Indicates the number of times the execution has restarted from the beginning.", "type": "integer" } }, "type": "object", "description": "Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12", "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails" }, "GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest": { "type": "object", "id": "GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest", "description": "Request for TakeoverTestCaseEditLock.", "properties": {} }, "EnterpriseCrmEventbusProtoStringArrayFunction": { "id": "EnterpriseCrmEventbusProtoStringArrayFunction", "properties": { "functionName": { "type": "string", "enum": [ "UNSPECIFIED", "GET", "APPEND", "SIZE", "TO_SET", "APPEND_ALL", "TO_JSON", "SET", "REMOVE", "REMOVE_AT", "CONTAINS", "FOR_EACH", "FILTER" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "" ] } }, "type": "object" }, "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims": { "id": "GoogleCloudConnectorsV1AuthConfigOauth2JwtBearerJwtClaims", "type": "object", "description": "JWT claims used for the jwt-bearer authorization grant.", "properties": { "audience": { "type": "string", "description": "Optional. Value for the \"aud\" claim." }, "subject": { "description": "Optional. Value for the \"sub\" claim.", "type": "string" }, "issuer": { "description": "Optional. Value for the \"iss\" claim.", "type": "string" } } }, "GoogleCloudIntegrationsV1alphaJwt": { "id": "GoogleCloudIntegrationsV1alphaJwt", "properties": { "jwtHeader": { "description": "Identifies which algorithm is used to generate the signature.", "type": "string" }, "secret": { "description": "User's pre-shared secret to sign the token.", "type": "string" }, "jwt": { "type": "string", "description": "The token calculated by the header, payload and signature." }, "jwtPayload": { "description": "Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.", "type": "string" } }, "description": "Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected.", "type": "object" }, "GoogleCloudIntegrationsV1alphaExecuteEventResponse": { "description": "The response for executing an integration.", "type": "object", "properties": { "executionId": { "description": "The id of the execution corresponding to this run of integration.", "type": "string" } }, "id": "GoogleCloudIntegrationsV1alphaExecuteEventResponse" }, "EnterpriseCrmEventbusProtoBaseFunction": { "id": "EnterpriseCrmEventbusProtoBaseFunction", "type": "object", "properties": { "functionName": { "type": "string", "enum": [ "UNSPECIFIED", "NOW_IN_MILLIS", "INT_LIST", "ENVIRONMENT", "GET_EXECUTION_ID", "GET_INTEGRATION_NAME", "GET_REGION", "GET_UUID", "GET_PROJECT_ID" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "" ] } } }, "GoogleCloudIntegrationsV1alphaResolveSuspensionResponse": { "description": "Response for Suspensions.ResolveSuspensions.", "id": "GoogleCloudIntegrationsV1alphaResolveSuspensionResponse", "type": "object", "properties": {} }, "EnterpriseCrmFrontendsEventbusProtoWorkflowParameters": { "type": "object", "description": "LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as \"children\" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters.", "id": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameters", "properties": { "parameters": { "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry" }, "type": "array", "description": "Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution." } } }, "GoogleCloudIntegrationsV1alphaEventParameter": { "id": "GoogleCloudIntegrationsV1alphaEventParameter", "description": "This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Next available id: 4", "properties": { "value": { "description": "Values for the defined keys. Each value can either be string, int, double or any proto message.", "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, "masked": { "description": "True if this parameter should be masked in the logs", "type": "boolean" }, "key": { "type": "string", "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition." } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaSfdcInstance": { "properties": { "serviceAuthority": { "description": "Optional. URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).", "type": "string" }, "sfdcOrgId": { "type": "string", "description": "The SFDC Org Id. This is defined in salesforce." }, "updateTime": { "description": "Output only. Time when the instance was last updated", "type": "string", "format": "google-datetime", "readOnly": true }, "description": { "description": "Optional. A description of the sfdc instance.", "type": "string" }, "authConfigId": { "items": { "type": "string" }, "description": "A list of AuthConfigs that can be tried to open the channel to SFDC", "type": "array" }, "name": { "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.", "type": "string" }, "createTime": { "readOnly": true, "description": "Output only. Time when the instance is created", "type": "string", "format": "google-datetime" }, "displayName": { "type": "string", "description": "Optional. User selected unique name/alias to easily reference an instance." }, "deleteTime": { "readOnly": true, "type": "string", "description": "Output only. Time when the instance was deleted. Empty if not deleted.", "format": "google-datetime" } }, "type": "object", "description": "The SfdcInstance resource use to hold channels and connection config data.", "id": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "GoogleCloudIntegrationsV1alphaListConnectionsResponse": { "type": "object", "description": "Response containing Connections listed by region.", "properties": { "nextPageToken": { "description": "Next page token.", "type": "string" }, "connections": { "type": "array", "description": "Connections.", "items": { "$ref": "GoogleCloudConnectorsV1Connection" } } }, "id": "GoogleCloudIntegrationsV1alphaListConnectionsResponse" }, "GoogleCloudIntegrationsV1alphaTriggerConfig": { "type": "object", "description": "Configuration detail of a trigger.", "id": "GoogleCloudIntegrationsV1alphaTriggerConfig", "properties": { "inputVariables": { "description": "Optional. List of input variables for the api trigger.", "$ref": "GoogleCloudIntegrationsV1alphaTriggerConfigVariables" }, "position": { "$ref": "GoogleCloudIntegrationsV1alphaCoordinate", "description": "Optional. Informs the front-end application where to draw this error catcher config on the UI." }, "alertConfig": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationAlertConfig" }, "description": "Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.", "type": "array" }, "startTasks": { "description": "Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).", "items": { "$ref": "GoogleCloudIntegrationsV1alphaNextTask" }, "type": "array" }, "outputVariables": { "$ref": "GoogleCloudIntegrationsV1alphaTriggerConfigVariables", "description": "Optional. List of output variables for the api trigger." }, "triggerId": { "description": "Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {\"Trigger name\": TRIGGER_NAME}", "type": "string" }, "trigger": { "description": "Optional. Name of the trigger. Example: \"API Trigger\", \"Cloud Pub Sub Trigger\" When set will be sent out to monitoring dashabord for tracking purpose.", "type": "string" }, "triggerType": { "description": "Optional. Type of trigger", "type": "string", "enum": [ "TRIGGER_TYPE_UNSPECIFIED", "CRON", "API", "SFDC_CHANNEL", "CLOUD_PUBSUB_EXTERNAL", "SFDC_CDC_CHANNEL", "CLOUD_SCHEDULER", "INTEGRATION_CONNECTOR_TRIGGER", "PRIVATE_TRIGGER", "CLOUD_PUBSUB", "EVENTARC_TRIGGER" ], "enumDescriptions": [ "Unknown.", "Trigger by scheduled time.", "Trigger by API call.", "Trigger by Salesforce Channel.", "Trigger by Pub/Sub external.", "SFDC Channel Trigger for CDC.", "Trigger by Cloud Scheduler job.", "Trigger by Connector Event", "Trigger for private workflow", "Trigger by cloud pub/sub for internal ip", "Trigger by Eventarc" ] }, "properties": { "type": "object", "description": "Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. \"name\" is a property for API triggers and \"subscription\" is a property for Pub/sub triggers.", "additionalProperties": { "type": "string" } }, "nextTasksExecutionPolicy": { "enumDescriptions": [ "Default.", "Execute all the tasks that satisfy their associated condition.", "Execute the first task that satisfies the associated condition." ], "type": "string", "enum": [ "NEXT_TASKS_EXECUTION_POLICY_UNSPECIFIED", "RUN_ALL_MATCH", "RUN_FIRST_MATCH" ], "description": "Optional. Dictates how next tasks will be executed." }, "cloudSchedulerConfig": { "$ref": "GoogleCloudIntegrationsV1alphaCloudSchedulerConfig", "description": "Optional. Cloud Scheduler Trigger related metadata" }, "errorCatcherId": { "type": "string", "description": "Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task" }, "label": { "description": "Optional. The user created label for a particular trigger.", "type": "string" }, "description": { "description": "Optional. User-provided description intended to give additional business context about the task.", "type": "string" }, "triggerNumber": { "type": "string", "description": "Required. A number to uniquely identify each trigger config within the integration on UI." } } }, "EnterpriseCrmFrontendsEventbusProtoParameterMapEntry": { "type": "object", "properties": { "key": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapField" }, "value": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapField" } }, "description": "Entry is a pair of key and value.", "id": "EnterpriseCrmFrontendsEventbusProtoParameterMapEntry" }, "GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest": { "properties": {}, "description": "Request for TakeoverEditLock.", "id": "GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest", "type": "object" }, "EnterpriseCrmEventbusProtoTaskAlertConfig": { "description": "Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.", "id": "EnterpriseCrmEventbusProtoTaskAlertConfig", "type": "object", "properties": { "durationThresholdMs": { "type": "string", "format": "int64", "description": "Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger." }, "onlyFinalAttempt": { "type": "boolean", "description": "Only count final task attempts, not retries." }, "errorEnumList": { "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" }, "aggregationPeriod": { "type": "string", "description": "The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week)." }, "playbookUrl": { "description": "Link to a playbook for resolving the issue that triggered this alert.", "type": "string" }, "clientId": { "type": "string", "description": "Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers." }, "alertName": { "description": "A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.", "type": "string" }, "thresholdValue": { "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue", "description": "The metric value, above or below which the alert should be triggered." }, "warningEnumList": { "$ref": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList" }, "numAggregationPeriods": { "format": "int32", "type": "integer", "description": "For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired." }, "thresholdType": { "type": "string", "enum": [ "UNSPECIFIED_THRESHOLD_TYPE", "EXPECTED_MIN", "EXPECTED_MAX" ], "description": "The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.", "enumDescriptions": [ "", "Note that this field will only trigger alerts if the workflow specifying it runs at least once in 24 hours (which is our in-memory retention period for monarch streams). Also note that `aggregation_period` for this alert configuration must be less than 24 hours.", "" ] }, "metricType": { "enumDescriptions": [ "The default value. Metric type should always be set to one of the other non-default values, otherwise it will result in an INVALID_ARGUMENT error.", "Specifies alerting on the rate of errors (potentially for a specific set of enum values) for the enclosing TaskConfig.", "Specifies alerting on the rate of warnings (potentially for a specific set of enum values) for the enclosing TaskConfig. Warnings use the same enum values as errors.", "Specifies alerting on the number of instances for the enclosing TaskConfig executed in the given aggregation_period.", "Specifies alerting on the average duration of execution for the enclosing task.", "Specifies alerting on the duration of a particular percentile of task executions. E.g. If 10% or more of the task executions have durations above 5 seconds, alert." ], "type": "string", "enum": [ "METRIC_TYPE_UNSPECIFIED", "TASK_ERROR_RATE", "TASK_WARNING_RATE", "TASK_RATE", "TASK_AVERAGE_DURATION", "TASK_PERCENTILE_DURATION" ] }, "alertDisabled": { "description": "Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.", "type": "boolean" } } }, "EnterpriseCrmFrontendsEventbusProtoParameterEntry": { "description": "Key-value pair of EventBus parameters.", "properties": { "key": { "type": "string", "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition." }, "dataType": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "", "", "" ], "description": "Explicitly getting the type of the parameter.", "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "PROTO_VALUE", "SERIALIZED_OBJECT_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "PROTO_ARRAY", "PROTO_ENUM", "BOOLEAN_ARRAY", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY", "NON_SERIALIZABLE_OBJECT", "JSON_VALUE" ] }, "masked": { "type": "boolean", "description": "True if this parameter should be masked in the logs" }, "value": { "description": "Values for the defined keys. Each value can either be string, int, double or any proto message.", "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType" } }, "id": "EnterpriseCrmFrontendsEventbusProtoParameterEntry", "type": "object" }, "GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse": { "properties": { "files": { "description": "List containing String representation for multiple file with type.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaSerializedFile" }, "type": "array" }, "content": { "description": "String representation of the requested file.", "type": "string" } }, "type": "object", "id": "GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse", "description": "Response for DownloadIntegrationVersion." }, "CrmlogErrorCode": { "id": "CrmlogErrorCode", "properties": { "commonErrorCode": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "SYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only.", "ASYNC_EVENTBUS_EXECUTION_TIMEOUT is for eventbus internal use only. This error will be counted as server availability error.", "", "", "", "", "" ], "enumDeprecated": [ false, true, false, false, true, true, true, false, false, true, false, false, 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, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "type": "string", "enum": [ "COMMON_ERROR_CODE_UNSPECIFIED", "INVALID_CREDENTIALS", "REQUIRED_FIELDS_MISSING", "INVALID_FIELDS", "BACKEND", "GENERAL", "INTERNAL", "IO_ERROR", "NOT_FOUND", "EVENT_BUS", "ALREADY_EXISTS", "CONCORD", "CONVERSION", "FLUME", "PERMISSION", "SALES_FORCE", "SPANNER", "UNIMPLEMENTED", "RELTIO", "WORKFLOW_NOT_FOUND", "QUOTA_THROTTLED", "QUOTA_ENQUEUED", "INVALID_QUOTA_CONFIGURATION", "TASK_NOT_FOUND", "EXECUTION_TIMEOUT", "INVALID_EVENT_EXECUTION_STATE", "INVALID_ATTRIBUTE", "MISSING_ATTRIBUTE", "CLIENT_UNAUTHORIZED_FOR_WORKFLOW", "INVALID_PARAMETER", "MISSING_PARAMETER", "UNAUTHROIZED_WORKFLOW_EDITOR_ACTION", "FAILED_PRECONDITION", "INVALID_CLIENT", "MISSING_CLIENT", "INVALID_WORKFLOW", "MISSING_QUOTA_CONFIGURATION", "UNHANDLED_TASK_ERROR", "SCRIPT_TASK_RUNTIME_ERROR", "RPC", "INVALID_PROTO", "UNHANDLED_EVENTBUS_ERROR", "INVALID_TASK_STATE", "TYPED_TASK_INVALID_INPUT_OPERATION", "TYPED_TASK_INVALID_OUTPUT_OPERATION", "VALIDATION_ERROR", "RESUME_ERROR", "APPS_SCRIPT_EXECUTION_ERROR", "INVALID_VECTOR_USER", "INFORMATICA", "RETRYABLE_TASK_ERROR", "INVALID_TENANT", "WRONG_TENANT", "INFORMATICA_BACKEND_UNAVAILABLE", "RPC_PERMISSION_DENIED", "SYNC_EVENTBUS_EXECUTION_TIMEOUT", "ASYNC_EVENTBUS_EXECUTION_TIMEOUT", "NOT_SUPPORTED_DATA_TYPE", "UNSANITIZED_USER_INPUT", "TRANSFORM_EXPRESSION_EVALUATION_ERROR", "HTTP_EXCEPTION", "EXECUTION_CANCELLED" ] } }, "type": "object", "description": "Registered ids for errors, as \"oneof\" enums. Each task or logical grouping of tasks may share the same enum." }, "GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorResponse": { "type": "object", "properties": {}, "id": "GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorResponse", "description": "Response for PostProvisioning rpc call." }, "EnterpriseCrmEventbusProtoExecutionTraceInfo": { "type": "object", "properties": { "traceId": { "description": "Used to aggregate ExecutionTraceInfo.", "type": "string" }, "parentEventExecutionInfoId": { "description": "Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.", "type": "string" } }, "description": "Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships.", "id": "EnterpriseCrmEventbusProtoExecutionTraceInfo" }, "EnterpriseCrmFrontendsEventbusProtoParameterValueType": { "properties": { "booleanArray": { "$ref": "EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray" }, "protoValue": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "stringValue": { "type": "string" }, "doubleValue": { "type": "number", "format": "double" }, "doubleArray": { "$ref": "EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray" }, "intValue": { "type": "string", "format": "int64" }, "protoArray": { "$ref": "EnterpriseCrmFrontendsEventbusProtoProtoParameterArray" }, "serializedObjectValue": { "$ref": "EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter" }, "stringArray": { "$ref": "EnterpriseCrmFrontendsEventbusProtoStringParameterArray" }, "jsonValue": { "type": "string" }, "booleanValue": { "type": "boolean" }, "intArray": { "$ref": "EnterpriseCrmFrontendsEventbusProtoIntParameterArray" } }, "id": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", "description": "To support various types of parameter values. Next available id: 14", "type": "object" }, "GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue": { "id": "GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValue", "type": "object", "properties": { "absolute": { "type": "string", "description": "Absolute value threshold.", "format": "int64" }, "percentage": { "type": "integer", "format": "int32", "description": "Percentage threshold." } }, "description": "The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig." }, "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse": { "type": "object", "properties": {}, "id": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse", "description": "Response for PublishIntegrationVersion." }, "GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest": { "id": "GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest", "description": "Request for UnpublishIntegrationVersion.", "properties": {}, "type": "object" }, "EnterpriseCrmEventbusProtoIntArrayFunction": { "type": "object", "id": "EnterpriseCrmEventbusProtoIntArrayFunction", "properties": { "functionName": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNSPECIFIED", "GET", "APPEND", "SIZE", "SUM", "AVG", "MAX", "MIN", "TO_SET", "APPEND_ALL", "TO_JSON", "SET", "REMOVE", "REMOVE_AT", "CONTAINS", "FOR_EACH", "FILTER" ] } } }, "GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate": { "type": "object", "description": "Define the template of IntegrationVersion.", "properties": { "key": { "type": "string", "description": "Required. Unique Key of the IntegrationVersion." }, "integrationVersion": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "description": "Required. Templatized version of integration." } }, "id": "GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate" }, "GoogleCloudConnectorsV1NodeConfig": { "type": "object", "description": "Node configuration for the connection.", "id": "GoogleCloudConnectorsV1NodeConfig", "properties": { "maxNodeCount": { "description": "Optional. Maximum number of nodes in the runtime nodes.", "type": "integer", "format": "int32" }, "minNodeCount": { "description": "Optional. Minimum number of nodes in the runtime nodes.", "type": "integer", "format": "int32" } } }, "GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse": { "type": "object", "properties": { "files": { "description": "List containing JSON for multiple file with type information.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaFile" }, "type": "array" } }, "description": "Response for DownloadJsonPackage.", "id": "GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse" }, "GoogleCloudConnectorsV1AuthConfigUserPassword": { "description": "Parameters to support Username and Password Authentication.", "id": "GoogleCloudConnectorsV1AuthConfigUserPassword", "type": "object", "properties": { "username": { "description": "Optional. Username.", "type": "string" }, "password": { "description": "Optional. Secret version reference containing the password.", "$ref": "GoogleCloudConnectorsV1Secret" } } }, "GoogleCloudIntegrationsV1alphaListSuspensionsResponse": { "id": "GoogleCloudIntegrationsV1alphaListSuspensionsResponse", "type": "object", "description": "Response for Suspensions.ListSuspensions.", "properties": { "suspensions": { "description": "The suspensions for the relevant execution which the caller has permissions to view and resolve.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaSuspension" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "Token to retrieve the next page of results." } } }, "GoogleCloudIntegrationsV1alphaRuntimeEntitySchema": { "id": "GoogleCloudIntegrationsV1alphaRuntimeEntitySchema", "type": "object", "properties": { "arrayFieldSchema": { "description": "The above schema, but for an array of the associated entity.", "type": "string" }, "fieldSchema": { "type": "string", "description": "List of fields in the entity." }, "entity": { "type": "string", "description": "Name of the entity." } }, "description": "Metadata of an entity, including a schema for its properties." }, "GoogleCloudIntegrationsV1alphaGetClientResponse": { "id": "GoogleCloudIntegrationsV1alphaGetClientResponse", "description": "Response for the GetClient rpc", "properties": { "client": { "description": "Required. Required: The client configuration that was requested", "$ref": "GoogleCloudIntegrationsV1alphaClientConfig" } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest": { "properties": {}, "id": "GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest", "type": "object", "description": "Request for ExecuteTestCases." }, "GoogleCloudIntegrationsV1alphaUploadTemplateRequest": { "description": "Request for UploadTemplate.", "id": "GoogleCloudIntegrationsV1alphaUploadTemplateRequest", "properties": { "content": { "description": "Required. The textproto of the template.", "type": "string" }, "fileFormat": { "description": "Required. File format for upload request.", "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "enumDescriptions": [ "Unspecified file format", "JSON File Format", "YAML File Format" ] } }, "type": "object" }, "EnterpriseCrmEventbusProtoMappedField": { "description": "Mapped field is a pair of input field and output field.", "type": "object", "properties": { "inputField": { "$ref": "EnterpriseCrmEventbusProtoField", "description": "The input field being mapped from." }, "outputField": { "description": "The output field being mapped to.", "$ref": "EnterpriseCrmEventbusProtoField" } }, "id": "EnterpriseCrmEventbusProtoMappedField" }, "GoogleCloudConnectorsV1EventingRuntimeData": { "properties": { "eventsListenerPscSa": { "description": "Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.", "type": "string", "readOnly": true }, "eventsListenerEndpoint": { "description": "Output only. Events listener endpoint. The value will populated after provisioning the events listener.", "type": "string", "readOnly": true }, "status": { "readOnly": true, "description": "Output only. Current status of eventing.", "$ref": "GoogleCloudConnectorsV1EventingStatus" }, "webhookData": { "description": "Output only. Webhook data.", "readOnly": true, "$ref": "GoogleCloudConnectorsV1EventingRuntimeDataWebhookData" }, "webhookSubscriptions": { "description": "Output only. Webhook subscriptions.", "$ref": "GoogleCloudConnectorsV1EventingRuntimeDataWebhookSubscriptions", "readOnly": true } }, "id": "GoogleCloudConnectorsV1EventingRuntimeData", "type": "object", "description": "Eventing runtime data has the details related to eventing managed by the system." }, "EnterpriseCrmEventbusProtoLoopMetadata": { "type": "object", "id": "EnterpriseCrmEventbusProtoLoopMetadata", "properties": { "errorMsg": { "description": "Add the error message when loops fail.", "type": "string" }, "failureLocation": { "type": "string", "enum": [ "UNKNOWN", "SUBWORKFLOW", "PARAM_OVERRIDING", "PARAM_AGGREGATING", "SETTING_ITERATION_ELEMENT", "GETTING_LIST_TO_ITERATE", "CONDITION_EVALUATION", "BUILDING_REQUEST" ], "enumDescriptions": [ "No error or Unknown.", "Subworkflow failed while firing/running.", "Param overrides failed.", "Param aggregation failed.", "Setting for loop current element failed.", "Getting the list to iterate.", "Evaluating the while loop condition.", "Building the iteration request" ], "description": "Indicates where in the loop logic did it error out." }, "currentIterationCount": { "description": "Starting from 1, not 0.", "format": "int64", "type": "string" }, "currentIterationDetail": { "description": "Needs to be set by the loop impl class before each iteration. The abstract loop class will append the request and response to it. Eg. The foreach Loop will clean up and set it as the current iteration element at the start of each loop. The post request and response will be appended to the value once they are available.", "type": "string" } } }, "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials": { "properties": { "clientId": { "description": "Optional. The client identifier.", "type": "string" }, "clientSecret": { "description": "Optional. Secret version reference containing the client secret.", "$ref": "GoogleCloudConnectorsV1Secret" } }, "id": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", "type": "object", "description": "Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details." }, "EnterpriseCrmFrontendsEventbusProtoIntParameterArray": { "id": "EnterpriseCrmFrontendsEventbusProtoIntParameterArray", "type": "object", "properties": { "intValues": { "items": { "format": "int64", "type": "string" }, "type": "array" } } }, "EnterpriseCrmEventbusProtoProtoArrayFunction": { "properties": { "functionName": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNSPECIFIED", "GET", "APPEND", "SIZE", "TO_SET", "APPEND_ALL", "TO_JSON", "SET", "REMOVE", "REMOVE_AT", "CONTAINS", "FOR_EACH", "FILTER" ] } }, "type": "object", "id": "EnterpriseCrmEventbusProtoProtoArrayFunction" }, "GoogleCloudConnectorsV1EncryptionKey": { "id": "GoogleCloudConnectorsV1EncryptionKey", "properties": { "kmsKeyName": { "type": "string", "description": "Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed." }, "type": { "description": "Optional. Specifies the type of the encryption key.", "enumDescriptions": [ "Value type is not specified.", "Google Managed.", "Customer Managed." ], "type": "string", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_MANAGED", "CUSTOMER_MANAGED" ] } }, "description": "Encryption Key value.", "type": "object" }, "EnterpriseCrmEventbusProtoTeardown": { "properties": { "teardownTaskConfigs": { "items": { "$ref": "EnterpriseCrmEventbusProtoTeardownTaskConfig" }, "description": "Required.", "type": "array" } }, "type": "object", "id": "EnterpriseCrmEventbusProtoTeardown" }, "EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig": { "type": "object", "properties": { "connection": { "$ref": "EnterpriseCrmEventbusProtoConnectorsConnection", "description": "User-selected connection." }, "operation": { "enumDescriptions": [ "", "", "", "", "", "", "", "" ], "description": "Operation to perform using the configured connection.", "type": "string", "enum": [ "OPERATION_UNSPECIFIED", "EXECUTE_ACTION", "LIST_ENTITIES", "GET_ENTITY", "CREATE_ENTITY", "UPDATE_ENTITY", "DELETE_ENTITY", "EXECUTE_QUERY" ] } }, "id": "EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig" }, "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest": { "id": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest", "type": "object", "properties": { "fileFormat": { "description": "File format for upload request.", "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "enumDescriptions": [ "Unspecified file format", "JSON File Format", "YAML File Format" ] }, "content": { "type": "string", "description": "Optional. The textproto of the IntegrationVersion." } }, "description": "Request for UploadIntegrationVersion." }, "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue": { "description": "The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig.", "properties": { "percentage": { "format": "int32", "type": "integer" }, "absolute": { "format": "int64", "type": "string" } }, "type": "object", "id": "EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValue" }, "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest": { "type": "object", "properties": { "inputParameters": { "type": "object", "description": "Optional. Input parameters used by test case execution.", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" } } }, "description": "The request for executing a functional test.", "id": "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest" }, "GoogleCloudConnectorsV1ConnectorVersionInfraConfig": { "description": "This configuration provides infra configs like rate limit threshold which need to be configurable for every connector version", "id": "GoogleCloudConnectorsV1ConnectorVersionInfraConfig", "type": "object", "properties": { "deploymentModel": { "readOnly": true, "enumDescriptions": [ "Deployment model is not specified.", "Default model gke mst.", "Cloud run mst." ], "description": "Output only. Indicates whether connector is deployed on GKE/CloudRun", "type": "string", "enum": [ "DEPLOYMENT_MODEL_UNSPECIFIED", "GKE_MST", "CLOUD_RUN_MST" ] }, "internalclientRatelimitThreshold": { "readOnly": true, "description": "Output only. Max QPS supported for internal requests originating from Connd.", "type": "string", "format": "int64" }, "ratelimitThreshold": { "format": "int64", "description": "Output only. Max QPS supported by the connector version before throttling of requests.", "type": "string", "readOnly": true }, "resourceRequests": { "$ref": "GoogleCloudConnectorsV1ResourceRequests", "description": "Output only. System resource requests.", "readOnly": true }, "connectionRatelimitWindowSeconds": { "type": "string", "description": "Output only. The window used for ratelimiting runtime requests to connections.", "format": "int64", "readOnly": true }, "tlsMigrationState": { "type": "string", "enum": [ "TLS_MIGRATION_STATE_UNSPECIFIED", "TLS_MIGRATION_NOT_STARTED", "TLS_MIGRATION_COMPLETED" ], "readOnly": true, "enumDescriptions": [ "TLS migration state is not specified.", "TLS migration is in progress.", "TLS migration is completed." ], "description": "Output only. Status of the TLS migration." }, "hpaConfig": { "description": "Output only. HPA autoscaling config.", "$ref": "GoogleCloudConnectorsV1HPAConfig", "readOnly": true }, "resourceLimits": { "description": "Output only. System resource limits.", "$ref": "GoogleCloudConnectorsV1ResourceLimits", "readOnly": true }, "deploymentModelMigrationState": { "type": "string", "enum": [ "DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED", "IN_PROGRESS", "COMPLETED", "ROLLEDBACK", "ROLLBACK_IN_PROGRESS" ], "description": "Output only. Status of the deployment model migration.", "enumDescriptions": [ "Deployment model migration state is not specified.", "Deployment model migration is in progress.", "Deployment model migration is completed.", "Deployment model migration rolledback.", "Deployment model migration rollback in progress." ], "readOnly": true }, "sharedDeployment": { "type": "string", "description": "Output only. The name of shared connector deployment.", "readOnly": true }, "maxInstanceRequestConcurrency": { "readOnly": true, "format": "int32", "description": "Output only. Max instance request concurrency.", "type": "integer" } } }, "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList": { "id": "EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumList", "properties": { "filterType": { "type": "string", "enum": [ "DEFAULT_INCLUSIVE", "EXCLUSIVE" ], "enumDescriptions": [ "", "" ] }, "enumStrings": { "type": "array", "items": { "type": "string" } } }, "type": "object", "description": "List of error enums for alerts." }, "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange": { "id": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRuleDoubleRange", "type": "object", "properties": { "min": { "description": "The inclusive minimum of the acceptable range.", "type": "number", "format": "double" }, "max": { "format": "double", "description": "The inclusive maximum of the acceptable range.", "type": "number" } }, "description": "Range used to validate doubles and floats." }, "EnterpriseCrmEventbusProtoCloudKmsConfig": { "type": "object", "id": "EnterpriseCrmEventbusProtoCloudKmsConfig", "properties": { "locationName": { "description": "Location name of the key ring, e.g. \"us-west1\".", "type": "string" }, "keyVersionName": { "description": "Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.", "type": "string" }, "serviceAccount": { "type": "string", "description": "Optional. The service account used for authentication of this KMS key. If this is not provided, the service account in Client.clientSource will be used." }, "keyRingName": { "type": "string", "description": "A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location." }, "gcpProjectId": { "type": "string", "description": "Optional. The id of GCP project where the KMS key is stored. If not provided, assume the key is stored in the same GCP project defined in Client (tag 14)." }, "keyName": { "type": "string", "description": "A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location." } } }, "GoogleCloudIntegrationsV1alphaDownloadExecutionResponse": { "id": "GoogleCloudIntegrationsV1alphaDownloadExecutionResponse", "properties": { "content": { "description": "The content of downloaded execution.", "type": "string" } }, "type": "object", "description": "Response for downloading an execution." }, "EnterpriseCrmEventbusProtoSuccessPolicy": { "type": "object", "description": "Policy that dictates the behavior for the task after it completes successfully.", "properties": { "finalState": { "enumDescriptions": [ "", "The default behavior, where successful tasks will be marked as SUCCEEDED.", "Sets the state to SUSPENDED after executing. This is required for SuspensionTask; event execution will continue once the user calls ResolveSuspensions with the event_execution_info_id and the task number." ], "type": "string", "enum": [ "UNSPECIFIED", "SUCCEEDED", "SUSPENDED" ], "description": "State to which the execution snapshot status will be set if the task succeeds." } }, "id": "EnterpriseCrmEventbusProtoSuccessPolicy" }, "GoogleCloudConnectorsV1EventingStatus": { "id": "GoogleCloudConnectorsV1EventingStatus", "properties": { "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "ERROR", "INGRESS_ENDPOINT_REQUIRED" ], "readOnly": true, "enumDescriptions": [ "Default state.", "Eventing is enabled and ready to receive events.", "Eventing is not active due to an error.", "Ingress endpoint required." ], "description": "Output only. State." }, "description": { "description": "Output only. Description of error if State is set to \"ERROR\".", "type": "string", "readOnly": true } }, "type": "object", "description": "EventingStatus indicates the state of eventing." }, "GoogleCloudIntegrationsV1alphaTestTaskConfig": { "id": "GoogleCloudIntegrationsV1alphaTestTaskConfig", "description": "The task mock configuration details and assertions for functional tests. Next available id: 6", "properties": { "taskNumber": { "type": "string", "description": "Required. This defines in the test case, the task in integration which will be mocked by this test task config" }, "assertions": { "items": { "$ref": "GoogleCloudIntegrationsV1alphaAssertion" }, "type": "array", "description": "Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case" }, "task": { "description": "Required. This defines in the test case, the task name in integration which will be mocked by this test task config", "type": "string" }, "mockConfig": { "$ref": "GoogleCloudIntegrationsV1alphaMockConfig", "description": "Optional. Defines how to mock the given task during test execution" }, "taskConfig": { "$ref": "GoogleCloudIntegrationsV1alphaTaskConfig", "description": "Optional. Auto-generated." } }, "type": "object" }, "EnterpriseCrmEventbusProtoParameterValueType": { "id": "EnterpriseCrmEventbusProtoParameterValueType", "description": "LINT.IfChange To support various types of parameter values. Next available id: 14", "properties": { "intArray": { "$ref": "EnterpriseCrmEventbusProtoIntParameterArray" }, "protoArray": { "$ref": "EnterpriseCrmEventbusProtoProtoParameterArray" }, "booleanArray": { "$ref": "EnterpriseCrmEventbusProtoBooleanParameterArray" }, "doubleValue": { "format": "double", "type": "number" }, "doubleArray": { "$ref": "EnterpriseCrmEventbusProtoDoubleParameterArray" }, "stringValue": { "type": "string" }, "intValue": { "format": "int64", "type": "string" }, "protoValue": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "stringArray": { "$ref": "EnterpriseCrmEventbusProtoStringParameterArray" }, "booleanValue": { "type": "boolean" }, "serializedObjectValue": { "$ref": "EnterpriseCrmEventbusProtoSerializedObjectParameter" } }, "type": "object" }, "EnterpriseCrmEventbusProtoTaskUiConfig": { "id": "EnterpriseCrmEventbusProtoTaskUiConfig", "description": "Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework:", "properties": { "taskUiModuleConfigs": { "items": { "$ref": "EnterpriseCrmEventbusProtoTaskUiModuleConfig" }, "type": "array", "description": "Configurations of included config modules." } }, "type": "object" }, "GoogleCloudIntegrationsV1alphaFile": { "description": "To store Integration version related file i.e. Integration Version, Config variable etc.", "type": "object", "id": "GoogleCloudIntegrationsV1alphaFile", "properties": { "type": { "enumDescriptions": [ "Default value.", "Integration file.", "Integration Config variables." ], "type": "string", "enum": [ "INTEGRATION_FILE_UNSPECIFIED", "INTEGRATION", "INTEGRATION_CONFIG_VARIABLES" ], "description": "File information like Integration version, Integration Config variables etc." }, "integrationVersion": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "description": "Integration version" }, "integrationConfig": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object", "description": "Integration version config file" } } }, "GoogleCloudIntegrationsV1alphaGenerateTokenResponse": { "type": "object", "description": "Returns success or error message", "id": "GoogleCloudIntegrationsV1alphaGenerateTokenResponse", "properties": { "message": { "description": "The message that notifies the user if the request succeeded or not.", "type": "string" } } }, "GoogleCloudIntegrationsV1alphaClientConfig": { "id": "GoogleCloudIntegrationsV1alphaClientConfig", "description": "The configuration information for the Client", "properties": { "enableManagedAiFeatures": { "description": "Optional. ", "type": "boolean" }, "customerConfig": { "description": "Optional. Customer configuration information for the given client.", "$ref": "GoogleCloudIntegrationsV1alphaCustomerConfig" }, "clientState": { "enumDescriptions": [ "The client state is unspecified", "The client is active and able to make calls to the IP APIs", "The client is disabled and will soon be deleted" ], "type": "string", "enum": [ "CLIENT_STATE_UNSPECIFIED", "CLIENT_STATE_ACTIVE", "CLIENT_STATE_DISABLED" ], "description": "Indicates the activity state the client" }, "projectId": { "description": "The GCP project id of the client associated with", "type": "string" }, "createTime": { "description": "The timestamp when the client was first created.", "format": "google-datetime", "type": "string" }, "region": { "type": "string", "description": "The region the client is linked to." }, "isGmek": { "type": "boolean", "description": "Optional. Indicates the client is provisioned with CMEK or GMEK." }, "id": { "description": "Globally unique ID (project_id + region)", "type": "string" }, "enableInternalIp": { "type": "boolean", "description": "Optional. Indicates the client enables internal IP feature, this is applicable for internal clients only." }, "enableVariableMasking": { "type": "boolean", "description": "Optional. " }, "description": { "type": "string", "description": "Description of what the client is used for" }, "enableHttpCall": { "type": "boolean", "description": "Optional. " }, "cloudKmsConfig": { "$ref": "GoogleCloudIntegrationsV1alphaCloudKmsConfig" }, "p4ServiceAccount": { "description": "The service agent associated with this client", "type": "string" }, "runAsServiceAccount": { "type": "string" }, "billingType": { "enumDescriptions": [ "Unspecified billing type", "A trial org provisioned through Apigee Provisioning Wizard", "Subscription based users of Apigee", "Consumption based users of IP" ], "description": "Indicates the billing type of the client", "type": "string", "enum": [ "BILLING_TYPE_UNSPECIFIED", "BILLING_TYPE_APIGEE_TRIALS", "BILLING_TYPE_APIGEE_SUBSCRIPTION", "BILLING_TYPE_PAYG" ] } }, "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoParamSpecEntry": { "properties": { "config": { "description": "Optional fields, such as help text and other useful info.", "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryConfig" }, "jsonSchema": { "description": "If the data_type is JSON_VALUE, then this will define its schema.", "type": "string" }, "defaultValue": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", "description": "Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." }, "protoDef": { "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryProtoDefinition", "description": "Populated if this represents a proto or proto array." }, "key": { "description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.", "type": "string" }, "validationRule": { "description": "Rule used to validate inputs (individual values and collection elements) for this parameter.", "$ref": "EnterpriseCrmEventbusProtoParamSpecEntryValidationRule" }, "isOutput": { "type": "boolean" }, "required": { "type": "boolean", "description": "If set, the user must provide an input value for this parameter." }, "className": { "description": "The FQCN of the Java object this represents. A string, for example, would be \"java.lang.String\". If this is \"java.lang.Object\", the parameter can be of any type.", "type": "string" }, "dataType": { "description": "The data type of the parameter.", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", "", "", "" ], "type": "string", "enum": [ "DATA_TYPE_UNSPECIFIED", "STRING_VALUE", "INT_VALUE", "DOUBLE_VALUE", "BOOLEAN_VALUE", "PROTO_VALUE", "SERIALIZED_OBJECT_VALUE", "STRING_ARRAY", "INT_ARRAY", "DOUBLE_ARRAY", "PROTO_ARRAY", "PROTO_ENUM", "BOOLEAN_ARRAY", "PROTO_ENUM_ARRAY", "BYTES", "BYTES_ARRAY", "NON_SERIALIZABLE_OBJECT", "JSON_VALUE" ] }, "collectionElementClassName": { "type": "string", "description": "If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is \"java.lang.Object\", the parameter is a collection of any type." }, "isDeprecated": { "description": "If set, this entry is deprecated, so further use of this parameter should be prohibited.", "type": "boolean" } }, "id": "EnterpriseCrmFrontendsEventbusProtoParamSpecEntry", "description": "Key-value pair of EventBus task parameters. Next id: 13", "type": "object" }, "GoogleCloudIntegrationsV1alphaAssertionResult": { "id": "GoogleCloudIntegrationsV1alphaAssertionResult", "type": "object", "properties": { "failureMessage": { "description": "Details of the assertion failure", "type": "string" }, "taskName": { "description": "Task name of task where the assertion was run.", "type": "string" }, "assertion": { "description": "Assertion that was run.", "$ref": "GoogleCloudIntegrationsV1alphaAssertion" }, "status": { "enumDescriptions": [ "Unspecified assertion status", "Assertion succeeded", "Assertion failed" ], "description": "Status of assertion to signify if the assertion succeeded or failed", "type": "string", "enum": [ "ASSERTION_STATUS_UNSPECIFIED", "SUCCEEDED", "FAILED" ] }, "taskNumber": { "description": "Task number of task where the assertion was run.", "type": "string" } }, "description": "The result of an assertion." }, "EnterpriseCrmEventbusProtoFieldMappingConfig": { "description": "Field Mapping Config to map multiple output fields values from input fields values.", "type": "object", "properties": { "mappedFields": { "type": "array", "items": { "$ref": "EnterpriseCrmEventbusProtoMappedField" } } }, "id": "EnterpriseCrmEventbusProtoFieldMappingConfig" }, "GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest": { "properties": { "triggerId": { "type": "string", "description": "Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The trigger_id is in the format of `api_trigger/TRIGGER_NAME`." }, "requestId": { "type": "string", "description": "Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned." }, "parameterEntries": { "type": "array", "deprecated": true, "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" }, "description": "Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution." }, "executionId": { "type": "string", "description": "Optional. The id of the ON_HOLD execution to be resumed." }, "parameters": { "description": "Optional. Passed in as parameters to each integration execution. Redacted", "$ref": "EnterpriseCrmFrontendsEventbusProtoEventParameters", "deprecated": true }, "inputParameters": { "description": "Optional. Input parameters used by integration execution.", "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, "type": "object" }, "doNotPropagateError": { "type": "boolean", "description": "Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default." } }, "type": "object", "description": "The request for executing an integration.", "id": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest" }, "GoogleCloudIntegrationsV1alphaLiftSuspensionRequest": { "type": "object", "properties": { "suspensionResult": { "type": "string", "description": "User passed in suspension result and will be used to control workflow execution branching behavior by setting up corresponnding edge condition with suspension result. For example, if you want to lift the suspension, you can pass \"Approved\", or if you want to reject the suspension and terminate workfloe execution, you can pass \"Rejected\" and terminate the workflow execution with configuring the edge condition." } }, "description": "Request for lift Suspension", "id": "GoogleCloudIntegrationsV1alphaLiftSuspensionRequest" }, "GoogleCloudIntegrationsV1alphaListTemplatesResponse": { "id": "GoogleCloudIntegrationsV1alphaListTemplatesResponse", "type": "object", "properties": { "nextPageToken": { "description": "The token used to retrieve the next page results.", "type": "string" }, "templates": { "description": "List of templates retrieved.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaTemplate" }, "type": "array" } }, "description": "Response for a request to list templates" }, "EnterpriseCrmFrontendsEventbusProtoStringParameterArray": { "type": "object", "id": "EnterpriseCrmFrontendsEventbusProtoStringParameterArray", "properties": { "stringValues": { "type": "array", "items": { "type": "string" } } } }, "GoogleCloudIntegrationsV1alphaExecutionReplayInfo": { "properties": { "originalExecutionInfoId": { "description": "If this execution is a replay of another execution, then this field contains the original execution id.", "type": "string" }, "replayedExecutionInfoIds": { "description": "If this execution has been replayed, then this field contains the execution ids of the replayed executions.", "items": { "type": "string" }, "type": "array" }, "replayMode": { "type": "string", "enum": [ "REPLAY_MODE_UNSPECIFIED", "REPLAY_MODE_FROM_BEGINNING", "REPLAY_MODE_POINT_OF_FAILURE" ], "description": "Replay mode for the execution", "enumDescriptions": [ "Default value.", "Replay the original execution from the beginning.", "Replay the execution from the first failed task." ] }, "replayReason": { "description": "reason for replay", "type": "string" } }, "type": "object", "description": "Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship", "id": "GoogleCloudIntegrationsV1alphaExecutionReplayInfo" }, "EnterpriseCrmEventbusProtoBuganizerNotification": { "properties": { "templateId": { "description": "ID of the buganizer template to use. Optional.", "format": "int64", "type": "string" }, "assigneeEmailAddress": { "description": "Whom to assign the new bug. Optional.", "type": "string" }, "title": { "description": "Title of the issue to be created. Required.", "type": "string" }, "componentId": { "type": "string", "format": "int64", "description": "ID of the buganizer component within which to create a new issue. Required." } }, "type": "object", "id": "EnterpriseCrmEventbusProtoBuganizerNotification" }, "EnterpriseCrmEventbusProtoTaskMetadataAdmin": { "description": "Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.", "id": "EnterpriseCrmEventbusProtoTaskMetadataAdmin", "properties": { "googleGroupEmail": { "type": "string" }, "userEmail": { "type": "string" } }, "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoProtoParameterArray": { "id": "EnterpriseCrmFrontendsEventbusProtoProtoParameterArray", "type": "object", "properties": { "protoValues": { "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } } } }, "GoogleCloudConnectorsV1Connection": { "description": "Connection represents an instance of connector.", "type": "object", "id": "GoogleCloudConnectorsV1Connection", "properties": { "updateTime": { "format": "google-datetime", "description": "Output only. Updated time.", "readOnly": true, "type": "string" }, "serviceAccount": { "type": "string", "description": "Optional. Service account needed for runtime plane to access Google Cloud resources." }, "logConfig": { "$ref": "GoogleCloudConnectorsV1LogConfig", "description": "Optional. Log configuration for the connection." }, "createTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Created time." }, "connectorVersion": { "type": "string", "description": "Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource." }, "destinationConfigs": { "type": "array", "description": "Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).", "items": { "$ref": "GoogleCloudConnectorsV1DestinationConfig" } }, "connectorVersionInfraConfig": { "description": "Output only. Infra configs supported by Connector Version.", "$ref": "GoogleCloudConnectorsV1ConnectorVersionInfraConfig", "readOnly": true }, "suspended": { "type": "boolean", "description": "Optional. Suspended indicates if a user has suspended a connection or not." }, "status": { "$ref": "GoogleCloudConnectorsV1ConnectionStatus", "readOnly": true, "description": "Output only. Current status of the connection." }, "authConfig": { "description": "Optional. Configuration for establishing the connection's authentication with an external system.", "$ref": "GoogleCloudConnectorsV1AuthConfig" }, "serviceDirectory": { "description": "Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. \"projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors\"", "readOnly": true, "type": "string" }, "connectionRevision": { "format": "int64", "type": "string", "readOnly": true, "description": "Output only. Connection revision. This field is only updated when the connection is created or updated by User." }, "description": { "type": "string", "description": "Optional. Description of the resource." }, "fallbackOnAdminCredentials": { "type": "boolean", "description": "Optional. Fallback on admin credentials for the connection. If this both auth_override_enabled and fallback_on_admin_credentials are set to true, the connection will use the admin credentials if the dynamic auth header is not present during auth override." }, "host": { "description": "Output only. The name of the Hostname of the Service Directory service with TLS.", "readOnly": true, "type": "string" }, "envoyImageLocation": { "description": "Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}", "type": "string", "readOnly": true }, "eventingRuntimeData": { "description": "Output only. Eventing Runtime Data.", "readOnly": true, "$ref": "GoogleCloudConnectorsV1EventingRuntimeData" }, "tlsServiceDirectory": { "description": "Output only. The name of the Service Directory service with TLS.", "type": "string", "readOnly": true }, "connectorVersionLaunchStage": { "enumDescriptions": [ "LAUNCH_STAGE_UNSPECIFIED.", "PREVIEW.", "GA.", "DEPRECATED.", "TEST.", "PRIVATE_PREVIEW." ], "type": "string", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", "PREVIEW", "GA", "DEPRECATED", "TEST", "PRIVATE_PREVIEW" ], "description": "Output only. Flag to mark the version indicating the launch stage.", "readOnly": true }, "isTrustedTester": { "description": "Output only. Is trusted tester program enabled for the project.", "readOnly": true, "type": "boolean" }, "adminFilters": { "items": { "$ref": "GoogleCloudConnectorsV1AdminFilters" }, "type": "array", "description": "Optional. Admin filters for the connection. These are used by Gemini Enterprise." }, "configVariables": { "type": "array", "description": "Optional. Configuration for configuring the connection with an external system.", "items": { "$ref": "GoogleCloudConnectorsV1ConfigVariable" } }, "sslConfig": { "$ref": "GoogleCloudConnectorsV1SslConfig", "description": "Optional. Ssl config of a connection" }, "asyncOperationsEnabled": { "description": "Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.", "type": "boolean" }, "imageLocation": { "readOnly": true, "description": "Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}", "type": "string" }, "billingConfig": { "readOnly": true, "$ref": "GoogleCloudConnectorsV1BillingConfig", "description": "Output only. Billing config for the connection." }, "trafficShapingConfigs": { "description": "Optional. Traffic shaping configuration for the connection.", "type": "array", "items": { "$ref": "GoogleCloudConnectorsV1TrafficShapingConfig" } }, "eventingConfig": { "description": "Optional. Eventing config of a connection", "$ref": "GoogleCloudConnectorsV1EventingConfig" }, "lockConfig": { "description": "Optional. Configuration that indicates whether or not the Connection can be edited.", "$ref": "GoogleCloudConnectorsV1LockConfig" }, "name": { "readOnly": true, "type": "string", "description": "Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}" }, "euaOauthAuthConfig": { "description": "Optional. Additional Oauth2.0 Auth config for EUA. If the connection is configured using non-OAuth authentication but OAuth needs to be used for EUA, this field can be populated with the OAuth config. This should be a OAuth2AuthCodeFlow Auth type only.", "$ref": "GoogleCloudConnectorsV1AuthConfig" }, "labels": { "description": "Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources", "additionalProperties": { "type": "string" }, "type": "object" }, "eventingEnablementType": { "description": "Optional. Eventing enablement type. Will be nil if eventing is not enabled.", "type": "string", "enum": [ "EVENTING_ENABLEMENT_TYPE_UNSPECIFIED", "EVENTING_AND_CONNECTION", "ONLY_EVENTING" ], "enumDescriptions": [ "Eventing Enablement Type Unspecifeied.", "Both connection and eventing.", "Only Eventing." ] }, "authOverrideEnabled": { "description": "Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API.", "type": "boolean" }, "subscriptionType": { "description": "Output only. This subscription type enum states the subscription type of the project.", "readOnly": true, "enumDescriptions": [ "Unspecified subscription type.", "PayG subscription.", "Paid Subscription." ], "type": "string", "enum": [ "SUBSCRIPTION_TYPE_UNSPECIFIED", "PAY_G", "PAID" ] }, "nodeConfig": { "description": "Optional. Node configuration for the connection.", "$ref": "GoogleCloudConnectorsV1NodeConfig" } } }, "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult": { "type": "object", "properties": { "version": { "description": "The version of the integration version.", "type": "string" }, "region": { "description": "The region of the integration version.", "type": "string" }, "name": { "description": "The integration document metadata.", "type": "string" }, "status": { "readOnly": true, "description": "Output only. The status of the integration version.", "enumDescriptions": [ "Default.", "Draft.", "Active.", "Archived.", "Snapshot." ], "type": "string", "enum": [ "INTEGRATION_STATE_UNSPECIFIED", "DRAFT", "ACTIVE", "ARCHIVED", "SNAPSHOT" ] }, "description": { "description": "The description of the integration version.", "type": "string" }, "createTime": { "type": "string", "description": "Output only. The create time of the integration version.", "format": "google-datetime", "readOnly": true }, "id": { "description": "The integration id.", "type": "string" }, "creator": { "type": "string", "description": "The creator of the integration version." } }, "id": "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponseIntegrationSearchResult", "description": "The integration search result with integration level information." }, "EnterpriseCrmEventbusProtoBooleanArrayFunction": { "type": "object", "id": "EnterpriseCrmEventbusProtoBooleanArrayFunction", "properties": { "functionName": { "type": "string", "enum": [ "UNSPECIFIED", "GET", "APPEND", "SIZE", "TO_SET", "APPEND_ALL", "TO_JSON", "SET", "REMOVE", "REMOVE_AT", "CONTAINS", "FOR_EACH", "FILTER" ], "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "" ] } } }, "EnterpriseCrmEventbusProtoIntFunction": { "type": "object", "properties": { "functionName": { "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "type": "string", "enum": [ "UNSPECIFIED", "ADD", "SUBTRACT", "MULTIPLY", "DIVIDE", "EXPONENT", "GREATER_THAN_EQUAL_TO", "GREATER_THAN", "LESS_THAN_EQUAL_TO", "LESS_THAN", "TO_DOUBLE", "TO_STRING", "EQUALS", "TO_JSON", "MOD", "EPOCH_TO_HUMAN_READABLE_TIME" ] } }, "id": "EnterpriseCrmEventbusProtoIntFunction" }, "GoogleCloudIntegrationsV1alphaUseTemplateResponse": { "id": "GoogleCloudIntegrationsV1alphaUseTemplateResponse", "description": "Response for use template", "properties": { "integrationVersion": { "description": "IntegrationVersion which is created.", "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "subIntegrationVersions": { "type": "array", "items": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "description": "Sub integration versions which are created." } }, "type": "object" } }, "servicePath": "", "resources": { "projects": { "methods": { "getClientmetadata": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaGetClientMetadataResponse" }, "description": "Gets the metadata info for the requested client", "httpMethod": "GET", "path": "v1/{+parent}/clientmetadata", "id": "integrations.projects.getClientmetadata", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/clientmetadata", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. Required: The ID of the GCP Project to be provisioned.", "pattern": "^projects/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "locations": { "resources": { "products": { "resources": { "certificates": { "methods": { "create": { "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "id": "integrations.projects.locations.products.certificates.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates", "parameters": { "parent": { "description": "Required. \"projects/{project}/locations/{location}\" format.", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "type": "string", "required": true, "location": "path" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "path": "v1/{+parent}/certificates", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "description": "Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates", "parameters": { "pageSize": { "format": "int32", "description": "The size of entries in the response. If unspecified, defaults to 100.", "location": "query", "type": "integer" }, "filter": { "type": "string", "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "location": "query" }, "readMask": { "format": "google-fieldmask", "description": "The mask which specifies fields that need to be returned in the Certificate's response.", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "description": "Required. The client, which owns this collection of Certificates.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$" }, "pageToken": { "location": "query", "description": "The token returned in the previous response.", "type": "string" } }, "id": "integrations.projects.locations.products.certificates.list", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListCertificatesResponse" }, "path": "v1/{+parent}/certificates", "description": "List all the certificates that match the filter. Restrict to certificate of current client only.", "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "delete": { "parameters": { "name": { "required": true, "location": "path", "description": "Required. The name that is associated with the Certificate.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Delete a certificate", "id": "integrations.projects.locations.products.certificates.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}", "path": "v1/{+name}" }, "patch": { "path": "v1/{+name}", "request": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Output only. Auto generated primary key", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$", "location": "path", "required": true }, "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Field mask specifying the fields in the above Certificate that have been modified and need to be updated." } }, "id": "integrations.projects.locations.products.certificates.patch" }, "get": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "description": "Get a certificates in the specified project.", "id": "integrations.projects.locations.products.certificates.get", "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/certificates/{certificatesId}", "parameters": { "name": { "description": "Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/certificates/[^/]+$", "required": true, "location": "path" } } } } }, "sfdcInstances": { "resources": { "sfdcChannels": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "location": "query", "description": "Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", "description": "Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.", "location": "path", "type": "string", "required": true } }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.patch", "request": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ] }, "list": { "parameters": { "pageToken": { "location": "query", "type": "string", "description": "The token returned in the previous response." }, "readMask": { "format": "google-fieldmask", "type": "string", "description": "The mask which specifies fields that need to be returned in the SfdcChannel's response.", "location": "query" }, "parent": { "description": "Required. The client, which owns this collection of SfdcChannels.", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", "type": "string", "required": true, "location": "path" }, "filter": { "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "The size of entries in the response. If unspecified, defaults to 100.", "location": "query" } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels", "description": "Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/sfdcChannels", "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.list" }, "get": { "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The name that is associated with the SfdcChannel." } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" } }, "delete": { "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.delete", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$", "description": "Required. The name that is associated with the SfdcChannel." } }, "description": "Deletes an sfdc channel." }, "create": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.", "parameters": { "parent": { "description": "Required. \"projects/{project}/locations/{location}\" format.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$" } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/sfdcChannels", "httpMethod": "POST", "id": "integrations.projects.locations.products.sfdcInstances.sfdcChannels.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels" } } } }, "methods": { "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", "description": "Required. The name that is associated with the SfdcInstance." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}", "id": "integrations.projects.locations.products.sfdcInstances.get", "path": "v1/{+name}", "httpMethod": "GET", "description": "Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" } }, "create": { "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "description": "Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "required": true, "description": "Required. \"projects/{project}/locations/{location}\" format.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "path": "v1/{+parent}/sfdcInstances", "id": "integrations.projects.locations.products.sfdcInstances.create", "parameterOrder": [ "parent" ] }, "list": { "parameterOrder": [ "parent" ], "description": "Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.", "path": "v1/{+parent}/sfdcInstances", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances", "parameters": { "pageToken": { "type": "string", "description": "The token returned in the previous response.", "location": "query" }, "readMask": { "type": "string", "format": "google-fieldmask", "description": "The mask which specifies fields that need to be returned in the SfdcInstance's response.", "location": "query" }, "pageSize": { "description": "The size of entries in the response. If unspecified, defaults to 100.", "type": "integer", "format": "int32", "location": "query" }, "parent": { "type": "string", "description": "Required. The client, which owns this collection of SfdcInstances.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "required": true }, "filter": { "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "location": "query", "type": "string" } }, "id": "integrations.projects.locations.products.sfdcInstances.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse" }, "httpMethod": "GET" }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Deletes an sfdc instance.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", "required": true, "description": "Required. The name that is associated with the SfdcInstance.", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}", "id": "integrations.projects.locations.products.sfdcInstances.delete", "path": "v1/{+name}" }, "patch": { "parameterOrder": [ "name" ], "path": "v1/{+name}", "parameters": { "name": { "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/sfdcInstances/[^/]+$", "location": "path" }, "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated." } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "id": "integrations.projects.locations.products.sfdcInstances.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/sfdcInstances/{sfdcInstancesId}", "request": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.", "httpMethod": "PATCH" } } }, "cloudFunctions": { "methods": { "create": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The project that the executed integration belongs to.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a cloud function project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/cloudFunctions", "request": { "$ref": "GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse" }, "path": "v1/{+parent}/cloudFunctions", "id": "integrations.projects.locations.products.cloudFunctions.create" } } }, "authConfigs": { "methods": { "patch": { "request": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "httpMethod": "PATCH", "description": "Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}", "parameters": { "clientCertificate.encryptedPrivateKey": { "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", "type": "string", "location": "query" }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.", "location": "query" }, "clientCertificate.passphrase": { "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", "location": "query", "type": "string" }, "name": { "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$", "required": true, "description": "Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.", "type": "string" }, "clientCertificate.sslCertificate": { "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", "location": "query", "type": "string" } }, "path": "v1/{+name}", "id": "integrations.projects.locations.products.authConfigs.patch" }, "get": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "id": "integrations.projects.locations.products.authConfigs.get", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The name that is associated with the AuthConfig." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}", "description": "Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config." }, "delete": { "description": "Deletes an auth config.", "parameters": { "name": { "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/authConfigs/[^/]+$", "description": "Required. The name that is associated with the AuthConfig." } }, "id": "integrations.projects.locations.products.authConfigs.delete", "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs/{authConfigsId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/authConfigs", "description": "Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListAuthConfigsResponse" }, "parameterOrder": [ "parent" ], "id": "integrations.projects.locations.products.authConfigs.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs", "parameters": { "filter": { "type": "string", "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The token returned in the previous response." }, "parent": { "description": "Required. The client, which owns this collection of AuthConfigs.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$" }, "pageSize": { "description": "The size of entries in the response. If unspecified, defaults to 100.", "location": "query", "type": "integer", "format": "int32" }, "readMask": { "description": "The mask which specifies fields that need to be returned in the AuthConfig's response.", "location": "query", "format": "google-fieldmask", "type": "string" } } }, "create": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "parameters": { "clientCertificate.passphrase": { "location": "query", "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", "type": "string" }, "clientCertificate.sslCertificate": { "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", "type": "string", "location": "query" }, "clientCertificate.encryptedPrivateKey": { "type": "string", "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", "location": "query" }, "parent": { "description": "Required. \"projects/{project}/locations/{location}\" format.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/authConfigs", "parameterOrder": [ "parent" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "id": "integrations.projects.locations.products.authConfigs.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/authConfigs", "description": "Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config." } } }, "integrations": { "methods": { "execute": { "description": "Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.", "request": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest" }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse" }, "id": "integrations.projects.locations.products.integrations.execute", "httpMethod": "POST", "path": "v1/{+name}:execute", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", "description": "Required. The integration resource name.", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:execute" }, "schedule": { "parameters": { "name": { "type": "string", "location": "path", "required": true, "description": "The integration resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "integrations.projects.locations.products.integrations.schedule", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:schedule", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse" }, "path": "v1/{+name}:schedule", "description": "Schedules an integration for execution by passing the trigger id and the scheduled time in the request body." }, "test": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsResponse" }, "description": "Execute the integration in draft state", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}:test", "request": { "$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", "description": "Output only. Auto-generated primary key.", "type": "string", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}:test", "id": "integrations.projects.locations.products.integrations.test" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationsResponse" }, "id": "integrations.projects.locations.products.integrations.list", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations", "path": "v1/{+parent}/integrations", "parameterOrder": [ "parent" ], "description": "Returns the list of all integrations in the specified project.", "parameters": { "pageSize": { "type": "integer", "description": "The page size for the resquest.", "location": "query", "format": "int32" }, "filter": { "type": "string", "description": "Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \"\u003e\" (greater), \"\u003c\" (less than), \u003e=\" (greater than or equal to), \"\u003c=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.", "location": "query" }, "parent": { "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+$", "description": "Required. Project and location from which the integrations should be listed. Format: projects/{project}" }, "pageToken": { "type": "string", "description": "The page token for the resquest.", "location": "query" }, "orderBy": { "description": "The results would be returned in order you specified here. Supported sort keys are: Descending sort order by \"last_modified_time\", \"created_time\", \"snapshot_number\". Ascending sort order by the integration name.", "location": "query", "type": "string" } } } }, "resources": { "executions": { "methods": { "list": { "parameterOrder": [ "parent" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListExecutionsResponse" }, "id": "integrations.projects.locations.products.integrations.executions.list", "description": "Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.", "path": "v1/{+parent}/executions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "truncateParams": { "type": "boolean", "location": "query", "description": "Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.", "deprecated": true }, "filterParams.taskStatuses": { "type": "string", "location": "query", "repeated": true, "deprecated": true, "description": "List of possible task statuses." }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The parent resource name of the integration execution." }, "filterParams.endTime": { "format": "int64", "type": "string", "description": "End timestamp.", "location": "query" }, "readMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info" }, "orderBy": { "location": "query", "description": "Optional. The results would be returned in order you specified here. Currently supporting \"create_time\".", "type": "string" }, "filterParams.workflowName": { "description": "Workflow name.", "type": "string", "location": "query" }, "filterParams.customFilter": { "location": "query", "description": "Optional user-provided custom filter.", "type": "string" }, "filterParams.parameterType": { "type": "string", "location": "query", "description": "Param type." }, "filterParams.parameterKey": { "description": "Param key. DEPRECATED. User parameter_pair_key instead.", "deprecated": true, "type": "string", "location": "query" }, "filterParams.startTime": { "location": "query", "description": "Start timestamp.", "format": "int64", "type": "string" }, "filterParams.parameterValue": { "deprecated": true, "description": "Param value. DEPRECATED. User parameter_pair_value instead.", "type": "string", "location": "query" }, "refreshAcl": { "description": "Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.", "location": "query", "type": "boolean" }, "filterParams.eventStatuses": { "location": "query", "repeated": true, "type": "string", "description": "List of possible event statuses." }, "filterParams.parameterPairKey": { "description": "Param key in the key value pair filter.", "location": "query", "type": "string" }, "snapshotMetadataWithoutParams": { "type": "boolean", "description": "Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters.", "location": "query" }, "pageToken": { "description": "Optional. The token returned in the previous response.", "type": "string", "location": "query" }, "filterParams.parameterPairValue": { "location": "query", "description": "Param value in the key value pair filter.", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The size of entries in the response.", "location": "query" }, "filterParams.executionId": { "description": "Execution id.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: \"parameter_type\" HAS \\\"string\\\" Also supports operators like AND, OR, NOT For example, trigger_id=\\\"id1\\\" AND workflow_name=\\\"testWorkflow\\\"", "location": "query", "type": "string" } } }, "download": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$", "location": "path", "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}" } }, "path": "v1/{+name}:download", "description": "Download the execution.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaDownloadExecutionResponse" }, "id": "integrations.projects.locations.products.integrations.executions.download" }, "get": { "id": "integrations.projects.locations.products.integrations.executions.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}", "httpMethod": "GET", "response": { "$ref": "GoogleCloudIntegrationsV1alphaExecution" }, "description": "Get an execution in the specified project.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$", "location": "path", "required": true, "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}" } } } }, "resources": { "suspensions": { "methods": { "list": { "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "integrations.projects.locations.products.integrations.executions.suspensions.list", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListSuspensionsResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions", "description": "* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "Maximum number of entries in the response.", "format": "int32" }, "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$", "description": "Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}" }, "orderBy": { "location": "query", "type": "string", "description": "Field name to order by." }, "filter": { "type": "string", "description": "Standard filter field.", "location": "query" }, "pageToken": { "description": "Token to retrieve a specific page.", "type": "string", "location": "query" } }, "path": "v1/{+parent}/suspensions", "parameterOrder": [ "parent" ] }, "resolve": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "integrations.projects.locations.products.integrations.executions.suspensions.resolve", "response": { "$ref": "GoogleCloudIntegrationsV1alphaResolveSuspensionResponse" }, "path": "v1/{+name}:resolve", "parameters": { "name": { "description": "Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}", "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$", "required": true } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest" }, "description": "* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve", "parameterOrder": [ "name" ] }, "lift": { "path": "v1/{+name}:lift", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "* Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.", "parameterOrder": [ "name" ], "httpMethod": "POST", "id": "integrations.projects.locations.products.integrations.executions.suspensions.lift", "request": { "$ref": "GoogleCloudIntegrationsV1alphaLiftSuspensionRequest" }, "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$", "required": true, "description": "Required. The resource that the suspension belongs to. \"projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}\" format." } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaLiftSuspensionResponse" } } } } } }, "versions": { "methods": { "create": { "description": "Create a integration with a draft version in the specified project.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "id": "integrations.projects.locations.products.integrations.versions.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions", "path": "v1/{+parent}/versions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$" }, "newIntegration": { "description": "Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.", "location": "query", "type": "boolean" }, "createSampleIntegrations": { "type": "boolean", "description": "Optional. Optional. Indicates if sample workflow should be created.", "location": "query" } } }, "publish": { "id": "integrations.projects.locations.products.integrations.versions.publish", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:publish", "path": "v1/{+name}:publish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest" }, "parameters": { "name": { "location": "path", "required": true, "description": "Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", "type": "string" } }, "description": "This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse" }, "parameterOrder": [ "name" ] }, "patch": { "id": "integrations.projects.locations.products.integrations.versions.patch", "request": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "description": "Update a integration with a draft version in the specified project.", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Field mask specifying the fields in the above integration that have been modified and need to be updated.", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", "description": "Output only. Auto-generated primary key.", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH" }, "unpublish": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "description": "Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.", "request": { "$ref": "GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest" }, "httpMethod": "POST", "id": "integrations.projects.locations.products.integrations.versions.unpublish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", "description": "Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "required": true, "location": "path", "type": "string" } }, "path": "v1/{+name}:unpublish", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish" }, "get": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", "description": "Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "location": "path", "type": "string", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "integrations.projects.locations.products.integrations.versions.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}", "description": "Get a integration in the specified project.", "path": "v1/{+name}", "response": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "httpMethod": "GET", "parameterOrder": [ "name" ] }, "download": { "httpMethod": "GET", "id": "integrations.projects.locations.products.integrations.versions.download", "description": "Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:download", "parameters": { "fileFormat": { "description": "File format for download request.", "location": "query", "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "enumDescriptions": [ "Unspecified file format", "JSON File Format", "YAML File Format" ] }, "files": { "enumDescriptions": [ "Default value.", "Integration file.", "Integration Config variables." ], "location": "query", "repeated": true, "type": "string", "enum": [ "INTEGRATION_FILE_UNSPECIFIED", "INTEGRATION", "INTEGRATION_CONFIG_VARIABLES" ], "description": "Optional. Integration related file to download like Integration Json, Config variable, testcase etc." }, "name": { "description": "Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse" }, "path": "v1/{+name}:download" }, "takeoverEditLock": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaTakeoverEditLockResponse" }, "parameterOrder": [ "integrationVersion" ], "parameters": { "integrationVersion": { "type": "string", "location": "path", "required": true, "description": "Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$" } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaTakeoverEditLockRequest" }, "id": "integrations.projects.locations.products.integrations.versions.takeoverEditLock", "path": "v1/{+integrationVersion}:takeoverEditLock", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}:takeoverEditLock", "httpMethod": "POST" }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", "location": "path", "type": "string", "required": true } }, "path": "v1/{+name}", "description": "Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.", "parameterOrder": [ "name" ], "id": "integrations.projects.locations.products.integrations.versions.delete", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}" }, "upload": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions:upload", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "v1/{+parent}/versions:upload", "description": "Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", "location": "path", "type": "string", "description": "Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse" }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest" }, "id": "integrations.projects.locations.products.integrations.versions.upload" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions", "parameters": { "filter": { "location": "query", "description": "Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \"\u003e\" (greater), \"\u003c\" (less than), \u003e=\" (greater than or equal to), \"\u003c=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.", "type": "string" }, "pageSize": { "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "parent": { "description": "Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\".", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", "location": "path", "required": true }, "orderBy": { "type": "string", "description": "The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last\\_modified\\_time\", \"created\\_time\", and \"snapshot\\_number\". Ascending sort order for `name`.", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token." }, "fieldMask": { "format": "google-fieldmask", "description": "The field mask which specifies the particular data to be returned.", "location": "query", "type": "string" } }, "path": "v1/{+parent}/versions", "parameterOrder": [ "parent" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse" }, "id": "integrations.projects.locations.products.integrations.versions.list", "description": "Returns the list of all integration versions in the specified project." } } } } } } }, "clients": { "methods": { "provisionClientPostProcessor": { "id": "integrations.projects.locations.clients.provisionClientPostProcessor", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorResponse" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaProvisionClientPostProcessorRequest" }, "description": "Perform post provisioning steps after client is provisioned.", "path": "v1/{+parent}/clients:provisionClientPostProcessor", "parameters": { "parent": { "location": "path", "description": "Required. Required: The ID of the GCP Project to be provisioned.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:provisionClientPostProcessor" }, "switchVariableMasking": { "path": "v1/{+parent}/clients:switchVariableMasking", "httpMethod": "POST", "id": "integrations.projects.locations.clients.switchVariableMasking", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:switchVariableMasking", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. Required: The ID of the GCP Project to be provisioned.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaSwitchVariableMaskingRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Update variable masking for provisioned client", "response": { "$ref": "GoogleProtobufEmpty" } }, "changeConfig": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:changeConfig", "id": "integrations.projects.locations.clients.changeConfig", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "description": "Required. Required: Format - projects/{project}/locations/{location}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaChangeCustomerConfigRequest" }, "path": "v1/{+parent}/clients:changeConfig", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaChangeCustomerConfigResponse" }, "description": "Updates the client customer configuration for the given project and location resource name" }, "toggleHttp": { "id": "integrations.projects.locations.clients.toggleHttp", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaToggleHttpRequest" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:toggleHttp", "parameterOrder": [ "parent" ], "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Enable/Disable http call for provisioned client", "parameters": { "parent": { "location": "path", "required": true, "description": "Required. Required: The ID of the GCP Project to be provisioned.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "path": "v1/{+parent}/clients:toggleHttp" }, "deprovision": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "integrations.projects.locations.clients.deprovision", "request": { "$ref": "GoogleCloudIntegrationsV1alphaDeprovisionClientRequest" }, "parameterOrder": [ "parent" ], "httpMethod": "POST", "path": "v1/{+parent}/clients:deprovision", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:deprovision", "description": "Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.", "parameters": { "parent": { "required": true, "location": "path", "description": "Required. Required: The ID of the GCP Project to be deprovisioned.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "switch": { "description": "Update client from GMEK to CMEK", "httpMethod": "POST", "path": "v1/{+parent}/clients:switch", "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "parent" ], "id": "integrations.projects.locations.clients.switch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:switch", "parameters": { "parent": { "description": "Required. Required: The ID of the GCP Project to be provisioned.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaSwitchEncryptionRequest" } }, "provision": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:provision", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "description": "Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.", "path": "v1/{+parent}/clients:provision", "request": { "$ref": "GoogleCloudIntegrationsV1alphaProvisionClientRequest" }, "id": "integrations.projects.locations.clients.provision", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. Required: The ID of the GCP Project to be provisioned.", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" } }, "replace": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "description": "Required. Required: The ID of the GCP Project to be provisioned.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients:replace", "request": { "$ref": "GoogleCloudIntegrationsV1alphaReplaceServiceAccountRequest" }, "description": "Update run-as service account for provisioned client", "path": "v1/{+parent}/clients:replace", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "id": "integrations.projects.locations.clients.replace", "response": { "$ref": "GoogleProtobufEmpty" } } } }, "templates": { "methods": { "share": { "httpMethod": "POST", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}:share", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:share", "request": { "$ref": "GoogleCloudIntegrationsV1alphaShareTemplateRequest" }, "id": "integrations.projects.locations.templates.share", "parameters": { "name": { "required": true, "location": "path", "type": "string", "description": "Required. The name that is associated with the Template.", "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Share a template with other clients. Only the template owner can share the templates with other projects. PERMISSION_DENIED would be thrown if the request is not from the owner." }, "create": { "httpMethod": "POST", "id": "integrations.projects.locations.templates.create", "response": { "$ref": "GoogleCloudIntegrationsV1alphaTemplate" }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/templates", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates", "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. \"projects/{project}/locations/{location}\" format.", "type": "string" } }, "description": "Creates a new template", "request": { "$ref": "GoogleCloudIntegrationsV1alphaTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "search": { "id": "integrations.projects.locations.templates.search", "description": "Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.", "httpMethod": "GET", "path": "v1/{+parent}/templates:search", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaSearchTemplatesResponse" }, "parameters": { "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000." }, "readMask": { "type": "string", "location": "query", "description": "Optional. The mask which specifies fields that need to be returned in the template's response.", "format": "google-fieldmask" }, "pageToken": { "location": "query", "description": "Optional. The token returned in the previous response.", "type": "string" }, "filter": { "description": "Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, \"status=\\\"ACTIVE\\\"", "location": "query", "type": "string" }, "query": { "type": "string", "location": "query", "description": "Optional. The search query that will be passed to Vertex search service." }, "enableNaturalLanguageQueryUnderstanding": { "type": "boolean", "description": "Optional. Whether to enable natural language query understanding.", "location": "query" }, "orderBy": { "description": "Optional. The results would be returned in the order you specified here.", "location": "query", "type": "string" }, "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The client, which owns this collection of Templates." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates:search" }, "use": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use", "parameters": { "name": { "type": "string", "description": "Required. The name that is associated with the Template.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "location": "path" } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequest" }, "id": "integrations.projects.locations.templates.use", "path": "v1/{+name}:use", "description": "Use the template to create integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateResponse" }, "parameterOrder": [ "name" ] }, "unshare": { "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "description": "Unshare a template from given clients. Owner of the template can unshare template with clients. Shared client can only unshare the template from itself. PERMISSION_DENIED would be thrown if request is not from owner or for unsharing itself.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1/{+name}:unshare", "request": { "$ref": "GoogleCloudIntegrationsV1alphaUnshareTemplateRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "type": "string", "description": "Required. The name that is associated with the Template.", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:unshare", "id": "integrations.projects.locations.templates.unshare" }, "import": { "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "location": "path", "description": "Required. The name that is associated with the Template." } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaImportTemplateRequest" }, "description": "Import the template to an existing integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:import", "id": "integrations.projects.locations.templates.import", "path": "v1/{+name}:import", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaImportTemplateResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Get a template in the specified project.", "id": "integrations.projects.locations.templates.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "required": true, "description": "Required. The template to retrieve. Format: projects/{project}/locations/{location}/templates/{template}", "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaTemplate" }, "path": "v1/{+name}" }, "patch": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "description": "Identifier. Resource name of the template.", "required": true, "type": "string", "location": "path" }, "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "description": "Required. Field mask specifying the fields in the above template that have been modified and must be updated." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "request": { "$ref": "GoogleCloudIntegrationsV1alphaTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the template by given id.", "httpMethod": "PATCH", "path": "v1/{+name}", "id": "integrations.projects.locations.templates.patch", "response": { "$ref": "GoogleCloudIntegrationsV1alphaTemplate" } }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name that is associated with the Template.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleProtobufEmpty" }, "id": "integrations.projects.locations.templates.delete", "description": "Deletes a template", "path": "v1/{+name}" }, "upload": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates:upload", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/templates:upload", "parameters": { "parent": { "description": "Required. The template to upload. Format: projects/{project}/locations/{location}", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "location": "path", "required": true } }, "description": "Uploads a template. The content can be a previously downloaded template. Performs the same function as CreateTemplate, but accepts input in a string format, which holds the complete representation of the Template content.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaUploadTemplateResponse" }, "id": "integrations.projects.locations.templates.upload", "request": { "$ref": "GoogleCloudIntegrationsV1alphaUploadTemplateRequest" } }, "list": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaListTemplatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "integrations.projects.locations.templates.list", "parameters": { "filter": { "type": "string", "location": "query", "description": "Optional. Standard filter field to filter templates. client_id filter won't be supported and will restrict to templates belonging to the current client only. Return all templates of the current client if the filter is empty. Also supports operators like AND, OR, NOT For example, \"status=\\\"ACTIVE\\\"" }, "readMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Optional. The mask which specifies fields that need to be returned in the template's response." }, "orderBy": { "type": "string", "description": "Optional. The results would be returned in the order you specified here.", "location": "query" }, "pageToken": { "description": "Optional. The token returned in the previous response.", "type": "string", "location": "query" }, "pageSize": { "description": "Optional. The size of the response entries. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "parent": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The client, which owns this collection of Templates." } }, "path": "v1/{+parent}/templates", "description": "Lists all templates matching the filter.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates", "httpMethod": "GET" }, "download": { "parameters": { "name": { "type": "string", "description": "Required. The template to download. Format: projects/{project}/locations/{location}/template/{template_id}", "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", "required": true, "location": "path" }, "fileFormat": { "enumDescriptions": [ "Unspecified file format", "JSON File Format", "YAML File Format" ], "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "description": "Required. File format for download request.", "location": "query" } }, "id": "integrations.projects.locations.templates.download", "response": { "$ref": "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download", "httpMethod": "GET", "path": "v1/{+name}:download", "parameterOrder": [ "name" ], "description": "Downloads a template. Retrieves the `Template` and returns the response as a string." } } }, "appsScriptProjects": { "methods": { "create": { "id": "integrations.projects.locations.appsScriptProjects.create", "path": "v1/{+parent}/appsScriptProjects", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The project that the executed integration belongs to." } }, "description": "Creates an Apps Script project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaCreateAppsScriptProjectRequest" } }, "link": { "path": "v1/{+parent}/appsScriptProjects:link", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectRequest" }, "id": "integrations.projects.locations.appsScriptProjects.link", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appsScriptProjects:link", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaLinkAppsScriptProjectResponse" }, "parameters": { "parent": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The project that the executed integration belongs to." } }, "description": "Links a existing Apps Script project." } } }, "integrations": { "methods": { "test": { "id": "integrations.projects.locations.integrations.test", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:test", "path": "v1/{+name}:test", "parameters": { "name": { "type": "string", "location": "path", "description": "Output only. Auto-generated primary key.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Execute the integration in draft state", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsResponse" }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest" }, "httpMethod": "POST" }, "execute": { "description": "Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute", "path": "v1/{+name}:execute", "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest" }, "id": "integrations.projects.locations.integrations.execute", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteIntegrationsResponse" }, "parameters": { "name": { "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", "description": "Required. The integration resource name." } }, "parameterOrder": [ "name" ] }, "search": { "path": "v1/{+parent}/integrations:search", "id": "integrations.projects.locations.integrations.search", "parameters": { "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `SearchIntegrations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchIntegrations` must match the call that provided the page token.", "type": "string" }, "enableNaturalLanguageQueryUnderstanding": { "description": "Optional. Whether to enable natural language query understanding.", "location": "query", "type": "boolean" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. The maximum number of results to return. The service may return fewer than this value. If unspecified, at most 10 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "location": "query" }, "query": { "type": "string", "description": "Required. The user query", "location": "query" }, "filter": { "type": "string", "location": "query", "description": "Optional. The pre-filter to be applied to the search. This should follow the expressions defined in https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata. For example, \"status:ANY(\"ACTIVE\")\" will return all the resources whose status contains the \"ACTIVE\"." }, "parent": { "required": true, "location": "path", "description": "Required. Project and location from which the integrations should be listed. Format: projects/*/locations/*/resources/integrations", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations:search", "response": { "$ref": "GoogleCloudIntegrationsV1alphaSearchIntegrationsResponse" }, "parameterOrder": [ "parent" ], "description": "Searches and returns the list of integrations in the specified project.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. Project and location from which the integrations should be listed. Format: projects/{project}", "type": "string" }, "orderBy": { "location": "query", "description": "The results would be returned in order you specified here. Supported sort keys are: Descending sort order by \"last_modified_time\", \"created_time\", \"snapshot_number\". Ascending sort order by the integration name.", "type": "string" }, "pageSize": { "format": "int32", "description": "The page size for the resquest.", "location": "query", "type": "integer" }, "filter": { "type": "string", "description": "Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \"\u003e\" (greater), \"\u003c\" (less than), \u003e=\" (greater than or equal to), \"\u003c=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`.", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The page token for the resquest." } }, "description": "Returns the list of all integrations in the specified project.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationsResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/integrations", "parameterOrder": [ "parent" ], "id": "integrations.projects.locations.integrations.list" }, "delete": { "path": "v1/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "integrations.projects.locations.integrations.delete", "parameters": { "name": { "description": "Required. The location resource of the request.", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Delete the selected integration and all versions inside", "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}" }, "executeEvent": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteEventResponse" }, "request": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "parameters": { "triggerId": { "location": "query", "description": "Required. Id of the integration trigger config. The trigger_id is in the format: `integration_connector_trigger/projects/{gcp_project_id}/location/{location}/connections/{connection_name}/subscriptions/{subscription_name}`.", "type": "string" }, "name": { "description": "Required. The integration resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration_id}", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$" } }, "path": "v1/{+name}:executeEvent", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "integrations.projects.locations.integrations.executeEvent", "description": "Executes an integration on receiving events from Integration Connector triggers, Eventarc or CPS Trigger. Input data to integration is received in body in json format", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:executeEvent", "httpMethod": "POST" }, "schedule": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsRequest" }, "path": "v1/{+name}:schedule", "parameters": { "name": { "location": "path", "type": "string", "required": true, "description": "The integration resource name.", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$" } }, "description": "Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.", "id": "integrations.projects.locations.integrations.schedule", "response": { "$ref": "GoogleCloudIntegrationsV1alphaScheduleIntegrationsResponse" }, "parameterOrder": [ "name" ] } }, "resources": { "executions": { "methods": { "download": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download", "description": "Download the execution.", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", "type": "string" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "integrations.projects.locations.integrations.executions.download", "path": "v1/{+name}:download", "response": { "$ref": "GoogleCloudIntegrationsV1alphaDownloadExecutionResponse" }, "httpMethod": "GET" }, "list": { "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions", "parameters": { "filterParams.eventStatuses": { "location": "query", "repeated": true, "type": "string", "description": "List of possible event statuses." }, "orderBy": { "description": "Optional. The results would be returned in order you specified here. Currently supporting \"create_time\".", "type": "string", "location": "query" }, "readMask": { "description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info", "format": "google-fieldmask", "type": "string", "location": "query" }, "filterParams.endTime": { "description": "End timestamp.", "format": "int64", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent resource name of the integration execution.", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", "required": true, "location": "path", "type": "string" }, "filterParams.taskStatuses": { "description": "List of possible task statuses.", "deprecated": true, "type": "string", "location": "query", "repeated": true }, "refreshAcl": { "description": "Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.", "location": "query", "type": "boolean" }, "filterParams.startTime": { "location": "query", "type": "string", "format": "int64", "description": "Start timestamp." }, "filterParams.parameterValue": { "location": "query", "type": "string", "deprecated": true, "description": "Param value. DEPRECATED. User parameter_pair_value instead." }, "filterParams.parameterKey": { "type": "string", "description": "Param key. DEPRECATED. User parameter_pair_key instead.", "deprecated": true, "location": "query" }, "filterParams.workflowName": { "location": "query", "type": "string", "description": "Workflow name." }, "filterParams.parameterPairKey": { "location": "query", "description": "Param key in the key value pair filter.", "type": "string" }, "snapshotMetadataWithoutParams": { "description": "Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters.", "location": "query", "type": "boolean" }, "filterParams.customFilter": { "type": "string", "description": "Optional user-provided custom filter.", "location": "query" }, "filterParams.executionId": { "location": "query", "type": "string", "description": "Execution id." }, "pageToken": { "type": "string", "location": "query", "description": "Optional. The token returned in the previous response." }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Optional. The size of entries in the response." }, "filterParams.parameterPairValue": { "description": "Param value in the key value pair filter.", "type": "string", "location": "query" }, "filterParams.parameterType": { "description": "Param type.", "location": "query", "type": "string" }, "truncateParams": { "description": "Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.", "type": "boolean", "location": "query", "deprecated": true }, "filter": { "description": "Optional. Standard filter field, we support filtering on following fields: workflow_name: the name of the integration. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: \"parameter_type\" HAS \\\"string\\\" Also supports operators like AND, OR, NOT For example, trigger_id=\\\"id1\\\" AND workflow_name=\\\"testWorkflow\\\"", "location": "query", "type": "string" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaListExecutionsResponse" }, "id": "integrations.projects.locations.integrations.executions.list", "path": "v1/{+parent}/executions", "httpMethod": "GET", "description": "Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI." }, "replay": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaReplayExecutionResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaReplayExecutionRequest" }, "id": "integrations.projects.locations.integrations.executions.replay", "path": "v1/{+name}:replay", "httpMethod": "POST", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay", "description": "Re-execute an existing execution, with same request parameters and execution strategy.", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", "description": "Required. Next ID: 6 The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration}/executions/{execution_id}", "required": true, "location": "path", "type": "string" } } }, "cancel": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:cancel", "path": "v1/{+name}:cancel", "description": "Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", "location": "path", "type": "string", "required": true } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaCancelExecutionRequest" }, "httpMethod": "POST", "id": "integrations.projects.locations.integrations.executions.cancel", "response": { "$ref": "GoogleCloudIntegrationsV1alphaCancelExecutionResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "integrations.projects.locations.integrations.executions.get", "path": "v1/{+name}", "description": "Get an execution in the specified project.", "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaExecution" } } }, "resources": { "suspensions": { "methods": { "lift": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaLiftSuspensionResponse" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "* Lifts suspension for the Suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.", "path": "v1/{+name}:lift", "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaLiftSuspensionRequest" }, "id": "integrations.projects.locations.integrations.executions.suspensions.lift", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The resource that the suspension belongs to. \"projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}\" format.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$" } } }, "resolve": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaResolveSuspensionResponse" }, "path": "v1/{+name}:resolve", "parameters": { "name": { "description": "Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+/suspensions/[^/]+$", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:resolve", "id": "integrations.projects.locations.integrations.executions.suspensions.resolve", "parameterOrder": [ "name" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest" } }, "list": { "description": "* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.", "httpMethod": "GET", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListSuspensionsResponse" }, "path": "v1/{+parent}/suspensions", "id": "integrations.projects.locations.integrations.executions.suspensions.list", "parameters": { "orderBy": { "description": "Field name to order by.", "location": "query", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Token to retrieve a specific page." }, "filter": { "location": "query", "type": "string", "description": "Standard filter field." }, "pageSize": { "description": "Maximum number of entries in the response.", "type": "integer", "location": "query", "format": "int32" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", "description": "Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/suspensions" } } } } }, "versions": { "resources": { "testCases": { "methods": { "patch": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaTestCase" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "id": "integrations.projects.locations.integrations.versions.testCases.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", "path": "v1/{+name}", "description": "Updates a test case", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "description": "Optional. Field mask specifying the fields in the above integration that have been modified and need to be updated.", "format": "google-fieldmask", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Output only. Auto-generated primary key." } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaTestCase" } }, "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaListTestCasesResponse" }, "path": "v1/{+parent}/testCases", "parameters": { "filter": { "description": "Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "type": "string", "location": "query" }, "orderBy": { "type": "string", "description": "Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for \"last_modified_time\", \"created_time\". Ascending sort order for \"name\".", "location": "query" }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The parent resource where this TestCase was created." }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 100 test cases will be returned." }, "readMask": { "format": "google-fieldmask", "description": "Optional. The mask which specifies fields that need to be returned in the TestCases's response.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all the test cases that satisfy the filters.", "httpMethod": "GET", "id": "integrations.projects.locations.integrations.versions.testCases.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases" }, "executeTest": { "description": "Executes functional test", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest", "httpMethod": "POST", "parameterOrder": [ "testCaseName" ], "id": "integrations.projects.locations.integrations.versions.testCases.executeTest", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest" }, "parameters": { "testCaseName": { "description": "Required. Test case resource name", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse" }, "path": "v1/{+testCaseName}:executeTest" }, "download": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:download", "id": "integrations.projects.locations.integrations.versions.testCases.download", "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.", "path": "v1/{+name}:download", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse" }, "parameters": { "fileFormat": { "location": "query", "description": "File format for download request.", "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "enumDescriptions": [ "Unspecified file format", "JSON File Format", "YAML File Format" ] }, "name": { "location": "path", "description": "Required. The test case to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$" } } }, "takeoverEditLock": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaTestCase" }, "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", "description": "Required. The ID of test case to takeover edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest" }, "id": "integrations.projects.locations.integrations.versions.testCases.takeoverEditLock", "path": "v1/{+name}:takeoverEditLock", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:takeoverEditLock", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Clear the lock fields and assign them to current user" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", "id": "integrations.projects.locations.integrations.versions.testCases.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}", "description": "Deletes a test case", "parameters": { "name": { "description": "Required. ID for the test case to be deleted", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", "type": "string", "required": true, "location": "path" } } }, "upload": { "request": { "$ref": "GoogleCloudIntegrationsV1alphaUploadTestCaseRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", "type": "string", "description": "Required. The test case to upload. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}", "required": true, "location": "path" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:upload", "response": { "$ref": "GoogleCloudIntegrationsV1alphaUploadTestCaseResponse" }, "httpMethod": "POST", "id": "integrations.projects.locations.integrations.versions.testCases.upload", "description": "Uploads a test case. The content can be a previously downloaded test case. Performs the same function as CreateTestCase, but accepts input in a string format, which holds the complete representation of the TestCase content.", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/testCases:upload", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaTestCase" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Get a test case", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The ID of the test case to retrieve", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", "id": "integrations.projects.locations.integrations.versions.testCases.get", "path": "v1/{+name}" }, "execute": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:execute", "httpMethod": "POST", "id": "integrations.projects.locations.integrations.versions.testCases.execute", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", "description": "Required. The parent resource whose test cases are executed. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}", "type": "string", "required": true, "location": "path" } }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCasesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCasesResponse" }, "parameterOrder": [ "parent" ], "path": "v1/{+parent}/testCases:execute", "description": "Executes all test cases in an integration version." }, "create": { "path": "v1/{+parent}/testCases", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaTestCase" }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaTestCase" }, "id": "integrations.projects.locations.integrations.versions.testCases.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "testCaseId": { "type": "string", "description": "Required. Required", "location": "query" }, "parent": { "location": "path", "required": true, "description": "Required. The parent resource where this test case will be created. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$" } }, "description": "Creates a new test case", "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases" } } } }, "methods": { "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "httpMethod": "DELETE", "description": "Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as \"HEAD\", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.", "id": "integrations.projects.locations.integrations.versions.delete", "response": { "$ref": "GoogleProtobufEmpty" } }, "upload": { "id": "integrations.projects.locations.integrations.versions.upload", "path": "v1/{+parent}/versions:upload", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionResponse" }, "description": "Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.", "request": { "$ref": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", "required": true, "location": "path", "type": "string", "description": "Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration}" } }, "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions:upload", "httpMethod": "POST" }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "parameters": { "updateMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "Field mask specifying the fields in the above integration that have been modified and need to be updated." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", "description": "Output only. Auto-generated primary key.", "type": "string", "location": "path", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "httpMethod": "PATCH", "id": "integrations.projects.locations.integrations.versions.patch", "description": "Update a integration with a draft version in the specified project." }, "downloadJsonPackage": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:downloadJsonPackage", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:downloadJsonPackage", "id": "integrations.projects.locations.integrations.versions.downloadJsonPackage", "description": "Downloads an Integration version package like IntegrationVersion,Integration Config etc. Retrieves the IntegrationVersion package for a given `integration_id` and returns the response as a JSON.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaDownloadJsonPackageResponse" }, "parameters": { "name": { "description": "Required. Integration version name Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", "required": true, "location": "path", "type": "string" }, "files": { "description": "Optional. Integration related file to download like Integration Version, Config variable, testcase etc.", "location": "query", "repeated": true, "enumDescriptions": [ "Default value.", "Integration file.", "Integration Config variables." ], "type": "string", "enum": [ "INTEGRATION_FILE_UNSPECIFIED", "INTEGRATION", "INTEGRATION_CONFIG_VARIABLES" ] } }, "parameterOrder": [ "name" ] }, "list": { "parameters": { "fieldMask": { "location": "query", "description": "The field mask which specifies the particular data to be returned.", "type": "string", "format": "google-fieldmask" }, "pageSize": { "format": "int32", "location": "query", "description": "The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "type": "integer" }, "pageToken": { "description": "A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of \":\" (containment), \"=\" (equality), \"\u003e\" (greater), \"\u003c\" (less than), \u003e=\" (greater than or equal to), \"\u003c=\" (less than or equal to), and \"!=\" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\\\"1\\\" AND state=ACTIVE AND description:\"test\". Filtering cannot be performed on repeated fields like `task_config`." }, "orderBy": { "description": "The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last\\_modified\\_time\", \"created\\_time\", and \"snapshot\\_number\". Ascending sort order for `name`.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", "required": true, "type": "string", "location": "path", "description": "Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\"." } }, "id": "integrations.projects.locations.integrations.versions.list", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListIntegrationVersionsResponse" }, "description": "Returns the list of all integration versions in the specified project.", "path": "v1/{+parent}/versions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions" }, "get": { "id": "integrations.projects.locations.integrations.versions.get", "response": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "httpMethod": "GET", "path": "v1/{+name}", "parameterOrder": [ "name" ], "description": "Get a integration in the specified project.", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "test": { "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:test", "id": "integrations.projects.locations.integrations.versions.test", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:test", "request": { "$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest" }, "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", "type": "string", "description": "Output only. Auto-generated primary key.", "required": true, "location": "path" } }, "description": "Execute the integration in draft state", "response": { "$ref": "GoogleCloudIntegrationsV1alphaTestIntegrationsResponse" }, "parameterOrder": [ "name" ] }, "publish": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionResponse" }, "description": "This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.", "path": "v1/{+name}:publish", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", "type": "string", "description": "Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}" } }, "id": "integrations.projects.locations.integrations.versions.publish", "request": { "$ref": "GoogleCloudIntegrationsV1alphaPublishIntegrationVersionRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:publish" }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions", "parameterOrder": [ "parent" ], "description": "Create a integration with a draft version in the specified project.", "httpMethod": "POST", "path": "v1/{+parent}/versions", "request": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "id": "integrations.projects.locations.integrations.versions.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion" }, "parameters": { "parent": { "type": "string", "description": "Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration}", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", "required": true, "location": "path" }, "createSampleIntegrations": { "description": "Optional. Optional. Indicates if sample workflow should be created.", "type": "boolean", "location": "query" }, "newIntegration": { "type": "boolean", "description": "Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.", "location": "query" } } }, "download": { "path": "v1/{+name}:download", "description": "Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:download", "id": "integrations.projects.locations.integrations.versions.download", "parameterOrder": [ "name" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaDownloadIntegrationVersionResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "files": { "location": "query", "repeated": true, "type": "string", "enum": [ "INTEGRATION_FILE_UNSPECIFIED", "INTEGRATION", "INTEGRATION_CONFIG_VARIABLES" ], "enumDescriptions": [ "Default value.", "Integration file.", "Integration Config variables." ], "description": "Optional. Integration related file to download like Integration Json, Config variable, testcase etc." }, "name": { "location": "path", "required": true, "description": "Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$" }, "fileFormat": { "description": "File format for download request.", "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "JSON", "YAML" ], "location": "query", "enumDescriptions": [ "Unspecified file format", "JSON File Format", "YAML File Format" ] } } }, "unpublish": { "response": { "$ref": "GoogleProtobufEmpty" }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaUnpublishIntegrationVersionRequest" }, "description": "Sets the status of the ACTIVE integration to SNAPSHOT with a new tag \"PREVIOUSLY_PUBLISHED\" after validating it. The \"HEAD\" and \"PUBLISH_REQUESTED\" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.", "parameters": { "name": { "required": true, "location": "path", "description": "Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$" } }, "parameterOrder": [ "name" ], "id": "integrations.projects.locations.integrations.versions.unpublish", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:unpublish", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}:unpublish" } } } } }, "certificates": { "methods": { "create": { "description": "Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.", "parameters": { "parent": { "description": "Required. \"projects/{project}/locations/{location}\" format.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "path": "v1/{+parent}/certificates", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates", "id": "integrations.projects.locations.certificates.create", "request": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" } }, "patch": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "description": "Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.", "httpMethod": "PATCH", "id": "integrations.projects.locations.certificates.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}", "parameters": { "updateMask": { "description": "Field mask specifying the fields in the above Certificate that have been modified and need to be updated.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "location": "path", "type": "string", "required": true, "description": "Output only. Auto generated primary key", "pattern": "^projects/[^/]+/locations/[^/]+/certificates/[^/]+$" } } }, "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "integrations.projects.locations.certificates.delete", "httpMethod": "DELETE", "description": "Delete a certificate", "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name that is associated with the Certificate.", "pattern": "^projects/[^/]+/locations/[^/]+/certificates/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}" }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaCertificate" }, "parameterOrder": [ "name" ], "description": "Get a certificates in the specified project.", "path": "v1/{+name}", "parameters": { "name": { "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/certificates/[^/]+$", "type": "string", "description": "Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate}" } }, "id": "integrations.projects.locations.certificates.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates/{certificatesId}", "httpMethod": "GET" }, "list": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "location": "path", "description": "Required. The client, which owns this collection of Certificates.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The token returned in the previous response." }, "filter": { "location": "query", "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "type": "string" }, "readMask": { "type": "string", "location": "query", "format": "google-fieldmask", "description": "The mask which specifies fields that need to be returned in the Certificate's response." }, "pageSize": { "format": "int32", "description": "The size of entries in the response. If unspecified, defaults to 100.", "type": "integer", "location": "query" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaListCertificatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/certificates", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificates", "httpMethod": "GET", "id": "integrations.projects.locations.certificates.list", "description": "List all the certificates that match the filter. Restrict to certificate of current client only." } } }, "cloudFunctions": { "methods": { "create": { "id": "integrations.projects.locations.cloudFunctions.create", "response": { "$ref": "GoogleCloudIntegrationsV1alphaCreateCloudFunctionResponse" }, "parameters": { "parent": { "description": "Required. The project that the executed integration belongs to.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "parent" ], "description": "Creates a cloud function project.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "GoogleCloudIntegrationsV1alphaCreateCloudFunctionRequest" }, "path": "v1/{+parent}/cloudFunctions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudFunctions" } } }, "authConfigs": { "methods": { "patch": { "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "id": "integrations.projects.locations.authConfigs.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Resource name of the auth config. For more information, see Manage authentication profiles. projects/{project}/locations/{location}/authConfigs/{authConfig}.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$", "required": true }, "updateMask": { "type": "string", "description": "Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.", "format": "google-fieldmask", "location": "query" }, "clientCertificate.encryptedPrivateKey": { "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", "location": "query", "type": "string" }, "clientCertificate.passphrase": { "type": "string", "location": "query", "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key." }, "clientCertificate.sslCertificate": { "location": "query", "type": "string", "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}", "description": "Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config." }, "list": { "httpMethod": "GET", "id": "integrations.projects.locations.authConfigs.list", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListAuthConfigsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authConfigs", "description": "Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.", "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. The client, which owns this collection of AuthConfigs.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "The token returned in the previous response.", "type": "string", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "location": "query", "description": "The size of entries in the response. If unspecified, defaults to 100." }, "filter": { "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "location": "query", "type": "string" }, "readMask": { "location": "query", "description": "The mask which specifies fields that need to be returned in the AuthConfig's response.", "type": "string", "format": "google-fieldmask" } }, "path": "v1/{+parent}/authConfigs", "parameterOrder": [ "parent" ] }, "delete": { "id": "integrations.projects.locations.authConfigs.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an auth config.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}", "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$", "description": "Required. The name that is associated with the AuthConfig.", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "path": "v1/{+name}" }, "get": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authConfigs/{authConfigsId}", "id": "integrations.projects.locations.authConfigs.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/authConfigs/[^/]+$", "type": "string", "description": "Required. The name that is associated with the AuthConfig.", "location": "path", "required": true } } }, "create": { "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "parameters": { "clientCertificate.sslCertificate": { "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----", "location": "query", "type": "string" }, "clientCertificate.encryptedPrivateKey": { "location": "query", "type": "string", "description": "The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. \"projects/{project}/locations/{location}\" format." }, "clientCertificate.passphrase": { "location": "query", "description": "'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.", "type": "string" } }, "id": "integrations.projects.locations.authConfigs.create", "response": { "$ref": "GoogleCloudIntegrationsV1alphaAuthConfig" }, "path": "v1/{+parent}/authConfigs" } } }, "sfdcInstances": { "methods": { "delete": { "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "id": "integrations.projects.locations.sfdcInstances.delete", "description": "Deletes an sfdc instance.", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name that is associated with the SfdcInstance.", "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$" } } }, "get": { "httpMethod": "GET", "description": "Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "id": "integrations.projects.locations.sfdcInstances.get", "parameters": { "name": { "type": "string", "location": "path", "description": "Required. The name that is associated with the SfdcInstance.", "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "httpMethod": "PATCH", "path": "v1/{+name}", "parameterOrder": [ "name" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}", "request": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "parameters": { "name": { "description": "Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$", "location": "path", "required": true }, "updateMask": { "location": "query", "description": "Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.", "type": "string", "format": "google-fieldmask" } }, "id": "integrations.projects.locations.sfdcInstances.patch" }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIntegrationsV1alphaListSfdcInstancesResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/sfdcInstances", "id": "integrations.projects.locations.sfdcInstances.list", "parameterOrder": [ "parent" ], "description": "Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances", "parameters": { "readMask": { "description": "The mask which specifies fields that need to be returned in the SfdcInstance's response.", "type": "string", "format": "google-fieldmask", "location": "query" }, "pageSize": { "format": "int32", "type": "integer", "description": "The size of entries in the response. If unspecified, defaults to 100.", "location": "query" }, "filter": { "location": "query", "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "type": "string" }, "pageToken": { "description": "The token returned in the previous response.", "type": "string", "location": "query" }, "parent": { "description": "Required. The client, which owns this collection of SfdcInstances.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true } } }, "create": { "description": "Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.", "path": "v1/{+parent}/sfdcInstances", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances", "id": "integrations.projects.locations.sfdcInstances.create", "request": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcInstance" }, "parameters": { "parent": { "location": "path", "required": true, "description": "Required. \"projects/{project}/locations/{location}\" format.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "sfdcChannels": { "methods": { "get": { "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.get", "parameters": { "name": { "description": "Required. The name that is associated with the SfdcChannel.", "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$" } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", "path": "v1/{+name}", "parameterOrder": [ "name" ], "description": "Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.", "httpMethod": "GET" }, "create": { "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$", "type": "string", "required": true, "location": "path", "description": "Required. \"projects/{project}/locations/{location}\" format." } }, "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "request": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "description": "Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1/{+parent}/sfdcChannels", "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels" }, "patch": { "parameterOrder": [ "name" ], "httpMethod": "PATCH", "response": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", "parameters": { "name": { "type": "string", "location": "path", "description": "Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$" }, "updateMask": { "format": "google-fieldmask", "description": "Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.", "location": "query", "type": "string" } }, "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.patch", "description": "Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.", "request": { "$ref": "GoogleCloudIntegrationsV1alphaSfdcChannel" }, "path": "v1/{+name}" }, "delete": { "parameters": { "name": { "description": "Required. The name that is associated with the SfdcChannel.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+/sfdcChannels/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels/{sfdcChannelsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes an sfdc channel.", "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "response": { "$ref": "GoogleProtobufEmpty" }, "path": "v1/{+name}" }, "list": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaListSfdcChannelsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.", "parameterOrder": [ "parent" ], "parameters": { "readMask": { "location": "query", "description": "The mask which specifies fields that need to be returned in the SfdcChannel's response.", "format": "google-fieldmask", "type": "string" }, "parent": { "location": "path", "required": true, "type": "string", "description": "Required. The client, which owns this collection of SfdcChannels.", "pattern": "^projects/[^/]+/locations/[^/]+/sfdcInstances/[^/]+$" }, "pageSize": { "location": "query", "format": "int32", "description": "The size of entries in the response. If unspecified, defaults to 100.", "type": "integer" }, "pageToken": { "location": "query", "description": "The token returned in the previous response.", "type": "string" }, "filter": { "type": "string", "description": "Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", "location": "query" } }, "id": "integrations.projects.locations.sfdcInstances.sfdcChannels.list", "path": "v1/{+parent}/sfdcChannels", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sfdcInstances/{sfdcInstancesId}/sfdcChannels", "httpMethod": "GET" } } } } }, "connections": { "methods": { "list": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaListConnectionsResponse" }, "id": "integrations.projects.locations.connections.list", "httpMethod": "GET", "parameterOrder": [ "parent" ], "description": "Lists Connections in a given project and location.", "parameters": { "pageSize": { "type": "integer", "location": "query", "description": "Page size.", "format": "int32" }, "orderBy": { "description": "Order by parameters.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "description": "Page token.", "location": "query" }, "filter": { "location": "query", "type": "string", "description": "Filter." }, "parent": { "description": "Required. Parent resource of the Connection, of the form: `projects/*/locations/*`", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path" } }, "path": "v1/{+parent}/connections", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getConnectionSchemaMetadata": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudIntegrationsV1alphaConnectionSchemaMetadata" }, "parameterOrder": [ "name" ], "description": "Lists the available entities and actions associated with a Connection.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/connectionSchemaMetadata", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/connectionSchemaMetadata$", "type": "string", "description": "Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata", "required": true, "location": "path" } }, "path": "v1/{+name}", "id": "integrations.projects.locations.connections.getConnectionSchemaMetadata", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "runtimeEntitySchemas": { "methods": { "list": { "response": { "$ref": "GoogleCloudIntegrationsV1alphaListRuntimeEntitySchemasResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1/{+parent}/runtimeEntitySchemas", "id": "integrations.projects.locations.connections.runtimeEntitySchemas.list", "parameters": { "pageToken": { "type": "string", "description": "Page token.", "location": "query" }, "parent": { "location": "path", "type": "string", "required": true, "description": "Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection}", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$" }, "filter": { "description": "Filter. Only the entity field with literal equality operator is supported.", "type": "string", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "Page size." } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeEntitySchemas", "description": "Lists the JSON schemas for the properties of runtime entities, filtered by entity name.", "parameterOrder": [ "parent" ] } } }, "runtimeActionSchemas": { "methods": { "list": { "description": "Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaListRuntimeActionSchemasResponse" }, "path": "v1/{+parent}/runtimeActionSchemas", "parameterOrder": [ "parent" ], "id": "integrations.projects.locations.connections.runtimeActionSchemas.list", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}/runtimeActionSchemas", "parameters": { "pageSize": { "description": "Page size.", "format": "int32", "type": "integer", "location": "query" }, "filter": { "description": "Filter. Only the action field with literal equality operator is supported.", "location": "query", "type": "string" }, "parent": { "location": "path", "description": "Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection}", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", "type": "string" }, "pageToken": { "type": "string", "description": "Page token.", "location": "query" } } } } } } } }, "methods": { "getClients": { "description": "Gets the client configuration for the given project and location resource name", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clients", "path": "v1/{+parent}/clients", "response": { "$ref": "GoogleCloudIntegrationsV1alphaGetClientResponse" }, "parameters": { "parent": { "type": "string", "location": "path", "required": true, "description": "Required. Required: The ID of the GCP Project to be provisioned.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "id": "integrations.projects.locations.getClients" }, "generateOpenApiSpec": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateOpenApiSpec", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. Project and location from which the integrations should be fetched. Format: projects/{project}/location/{location}" } }, "id": "integrations.projects.locations.generateOpenApiSpec", "request": { "$ref": "GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecRequest" }, "description": "Generate OpenAPI spec for the requested integrations and api triggers", "path": "v1/{+name}:generateOpenApiSpec", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIntegrationsV1alphaGenerateOpenApiSpecResponse" } } } } } }, "callback": { "methods": { "generateToken": { "path": "v1/callback:generateToken", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [], "flatPath": "v1/callback:generateToken", "httpMethod": "GET", "description": "Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.", "response": { "$ref": "GoogleCloudIntegrationsV1alphaGenerateTokenResponse" }, "id": "integrations.callback.generateToken", "parameters": { "product": { "location": "query", "type": "string", "enum": [ "UNSPECIFIED_PRODUCT", "IP", "APIGEE", "SECURITY" ], "description": "Which product sends the request", "enumDescriptions": [ "", "", "", "" ] }, "redirectUri": { "description": "Redirect uri of the auth code request", "type": "string", "location": "query" }, "code": { "type": "string", "description": "The auth code for the given request", "location": "query" }, "state": { "location": "query", "type": "string", "description": "The auth config id for the given request" }, "gcpProjectId": { "location": "query", "type": "string", "description": "The gcp project id of the request" } } } } }, "connectorPlatformRegions": { "methods": { "enumerate": { "flatPath": "v1/connectorPlatformRegions:enumerate", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1/connectorPlatformRegions:enumerate", "description": "Enumerates the regions for which Connector Platform is provisioned.", "id": "integrations.connectorPlatformRegions.enumerate", "response": { "$ref": "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse" }, "parameters": {} } } } }, "name": "integrations" }