Package-level declarations

Types

data class EnterpriseCrmEventbusProtoAttributesResponse(val dataType: String, val defaultValue: EnterpriseCrmEventbusProtoValueTypeResponse, val isRequired: Boolean, val isSearchable: Boolean, val logSettings: EnterpriseCrmEventbusProtoLogSettingsResponse, val searchable: String, val taskVisibility: List<String>)

Attributes are additional options that can be associated with each event property. For more information, see

List of error enums for alerts.

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.

data class EnterpriseCrmEventbusProtoCloudSchedulerConfigResponse(val cronTab: String, val errorMessage: String, val location: String, val serviceAccountEmail: String)

Cloud Scheduler Trigger configuration

This message recursively combines constituent conditions using logical AND.

Condition that uses operator to evaluate the key against the value.

Represents two-dimensional positions.

LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus.

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

data class EnterpriseCrmEventbusProtoFailurePolicyResponse(val intervalInSeconds: String, val maxNumRetries: Int, val retryStrategy: String)

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).

data class EnterpriseCrmEventbusProtoLogSettingsResponse(val logFieldName: String, val sanitizeOptions: EnterpriseCrmLoggingGwsSanitizeOptionsResponse, val seedPeriod: String, val seedScope: String, val shorteningLimits: EnterpriseCrmLoggingGwsFieldLimitsResponse)

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.

data class EnterpriseCrmEventbusProtoNextTaskResponse(val combinedConditions: List<EnterpriseCrmEventbusProtoCombinedConditionResponse>, val condition: String, val description: String, val label: String, val taskConfigId: String, val taskNumber: String)

The task that is next in line to be executed, if the condition specified evaluated to true.

The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).

data class EnterpriseCrmEventbusProtoNodeIdentifierResponse(val elementIdentifier: String, val elementType: String)

Represents a node identifier (type + id). Next highest id: 3

LINT.IfChange To support various types of parameter values. Next available id: 14

data class EnterpriseCrmEventbusProtoParamSpecEntryConfigResponse(val descriptivePhrase: String, val helpText: String, val hideDefaultValue: Boolean, val inputDisplayOption: String, val isHidden: Boolean, val label: String, val parameterNameOption: String, val subSectionLabel: String, val uiPlaceholderText: String)

Key-value pair of EventBus property.

Policy that dictates the behavior for the task after it completes successfully.

data class EnterpriseCrmEventbusProtoTaskAlertConfigResponse(val aggregationPeriod: String, val alertDisabled: Boolean, val alertName: String, val clientId: String, val durationThresholdMs: String, val errorEnumList: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumListResponse, val metricType: String, val numAggregationPeriods: Int, val onlyFinalAttempt: Boolean, val playbookUrl: String, val thresholdType: String, val thresholdValue: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValueResponse, val warningEnumList: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumListResponse)

Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.

data class EnterpriseCrmEventbusProtoTaskMetadataAdminResponse(val googleGroupEmail: String, val userEmail: String)

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.

data class EnterpriseCrmEventbusProtoTaskMetadataResponse(val activeTaskName: String, val admins: List<EnterpriseCrmEventbusProtoTaskMetadataAdminResponse>, val category: String, val codeSearchLink: String, val defaultJsonValidationOption: String, val defaultSpec: String, val description: String, val descriptiveName: String, val docMarkdown: String, val externalCategory: String, val externalCategorySequence: Int, val externalDocHtml: String, val externalDocLink: String, val externalDocMarkdown: String, val g3DocLink: String, val iconLink: String, val isDeprecated: Boolean, val name: String, val standaloneExternalDocHtml: String, val status: String, val system: String, val tags: List<String>)

TaskMetadata are attributes that are associated to every common Task we have.

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:

Task author would use this type to configure a config module.

data class EnterpriseCrmEventbusProtoTriggerCriteriaResponse(val condition: String, val parameters: EnterpriseCrmEventbusProtoEventParametersResponse, val triggerCriteriaTaskImplementationClassName: String)
data class EnterpriseCrmEventbusProtoValueTypeResponse(val booleanValue: Boolean, val doubleArray: EnterpriseCrmEventbusProtoDoubleArrayResponse, val doubleValue: Double, val intArray: EnterpriseCrmEventbusProtoIntArrayResponse, val intValue: String, val protoValue: Map<String, String>, val stringArray: EnterpriseCrmEventbusProtoStringArrayResponse, val stringValue: String)

Used for define type for values. Currently supported value types include int, string, double, array, and any proto message.

data class EnterpriseCrmEventbusProtoWorkflowAlertConfigResponse(val aggregationPeriod: String, val alertDisabled: Boolean, val alertName: String, val clientId: String, val durationThresholdMs: String, val errorEnumList: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumListResponse, val metricType: String, val numAggregationPeriods: Int, val onlyFinalAttempt: Boolean, val playbookUrl: String, val thresholdType: String, val thresholdValue: EnterpriseCrmEventbusProtoBaseAlertConfigThresholdValueResponse, val warningEnumList: EnterpriseCrmEventbusProtoBaseAlertConfigErrorEnumListResponse)

Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.

data class EnterpriseCrmEventbusStatsDimensionsResponse(val clientId: String, val enumFilterType: String, val errorEnumString: String, val retryAttempt: String, val taskName: String, val taskNumber: String, val triggerId: String, val warningEnumString: String, val workflowId: String, val workflowName: String)
Link copied to clipboard
data class EnterpriseCrmEventbusStatsResponse(val dimensions: EnterpriseCrmEventbusStatsDimensionsResponse, val durationInSeconds: Double, val errorRate: Double, val qps: Double, val warningRate: Double)

Stats for the requested dimensions: QPS, duration, and error/warning rate

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

Key-value pair of EventBus task parameters. Next id: 13

data class EnterpriseCrmFrontendsEventbusProtoRollbackStrategyResponse(val parameters: EnterpriseCrmFrontendsEventbusProtoEventParametersResponse, val rollbackTaskImplementationClassName: String, val taskNumbersToRollback: List<String>)

Next available id: 4

data class EnterpriseCrmFrontendsEventbusProtoTaskConfigResponse(val alertConfigs: List<EnterpriseCrmEventbusProtoTaskAlertConfigResponse>, val createTime: String, val creatorEmail: String, val description: String, val disableStrictTypeValidation: Boolean, val errorCatcherId: String, val externalTaskType: String, val failurePolicy: EnterpriseCrmEventbusProtoFailurePolicyResponse, val incomingEdgeCount: Int, val jsonValidationOption: String, val label: String, val lastModifiedTime: String, val nextTasks: List<EnterpriseCrmEventbusProtoNextTaskResponse>, val nextTasksExecutionPolicy: String, val parameters: Map<String, String>, val position: EnterpriseCrmEventbusProtoCoordinateResponse, val precondition: String, val preconditionLabel: String, val rollbackStrategy: EnterpriseCrmFrontendsEventbusProtoRollbackStrategyResponse, val successPolicy: EnterpriseCrmEventbusProtoSuccessPolicyResponse, val synchronousCallFailurePolicy: EnterpriseCrmEventbusProtoFailurePolicyResponse, val taskEntity: EnterpriseCrmFrontendsEventbusProtoTaskEntityResponse, val taskExecutionStrategy: String, val taskName: String, val taskNumber: String, val taskSpec: String, val taskTemplateName: String, val taskType: String)

The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.

Contains a task's metadata and associated information. Next available id: 7

data class EnterpriseCrmFrontendsEventbusProtoTriggerConfigResponse(val alertConfig: List<EnterpriseCrmEventbusProtoWorkflowAlertConfigResponse>, val cloudSchedulerConfig: EnterpriseCrmEventbusProtoCloudSchedulerConfigResponse, val description: String, val enabledClients: List<String>, val errorCatcherId: String, val label: String, val nextTasksExecutionPolicy: String, val pauseWorkflowExecutions: Boolean, val position: EnterpriseCrmEventbusProtoCoordinateResponse, val properties: Map<String, String>, val startTasks: List<EnterpriseCrmEventbusProtoNextTaskResponse>, val triggerCriteria: EnterpriseCrmEventbusProtoTriggerCriteriaResponse, val triggerId: String, val triggerNumber: String, val triggerType: String)

Configuration detail of a trigger. Next available id: 19

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.

data class EnterpriseCrmLoggingGwsFieldLimitsResponse(val logAction: String, val logType: List<String>, val maxArraySize: Int, val maxStringLength: Int, val shortenerType: String)

Describes string and array limits when writing to logs. When a limit is exceeded the shortener_type describes how to shorten the field. next_id: 6

data class EnterpriseCrmLoggingGwsSanitizeOptionsResponse(val isAlreadySanitized: Boolean, val logType: List<String>, val privacy: String, val sanitizeType: String)

Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5

Link copied to clipboard
data class GetAuthConfigResult(val certificateId: String, val createTime: String, val creatorEmail: String, val credentialType: String, val decryptedCredential: GoogleCloudIntegrationsV1alphaCredentialResponse, val description: String, val displayName: String, val encryptedCredential: String, val expiryNotificationDuration: List<String>, val lastModifierEmail: String, val name: String, val overrideValidTime: String, val reason: String, val state: String, val updateTime: String, val validTime: String, val visibility: String)
Link copied to clipboard
data class GetCertificateResult(val certificateStatus: String, val credentialId: String, val description: String, val displayName: String, val name: String, val rawCertificate: GoogleCloudIntegrationsV1alphaClientCertificateResponse, val requestorId: String, val validEndTime: String, val validStartTime: String)
Link copied to clipboard
data class GetSfdcChannelResult(val channelTopic: String, val createTime: String, val deleteTime: String, val description: String, val displayName: String, val isActive: Boolean, val lastReplayId: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetSfdcInstanceResult(val authConfigId: List<String>, val createTime: String, val deleteTime: String, val description: String, val displayName: String, val name: String, val serviceAuthority: String, val sfdcOrgId: String, val updateTime: String)
Link copied to clipboard
data class GetTemplatesVersionResult(val createTime: String, val databasePersistencePolicy: String, val description: String, val errorCatcherConfigs: List<GoogleCloudIntegrationsV1alphaErrorCatcherConfigResponse>, val lastModifierEmail: String, val name: String, val parentIntegrationVersionId: String, val snapshotNumber: String, val status: String, val taskConfigs: List<EnterpriseCrmFrontendsEventbusProtoTaskConfigResponse>, val teardown: EnterpriseCrmEventbusProtoTeardownResponse, val templateParameters: EnterpriseCrmFrontendsEventbusProtoWorkflowParametersResponse, val triggerConfigs: List<EnterpriseCrmFrontendsEventbusProtoTriggerConfigResponse>, val updateTime: String, val userLabel: String)
Link copied to clipboard
data class GetVersionResult(val createTime: String, val databasePersistencePolicy: String, val description: String, val errorCatcherConfigs: List<GoogleCloudIntegrationsV1alphaErrorCatcherConfigResponse>, val integrationParameters: List<GoogleCloudIntegrationsV1alphaIntegrationParameterResponse>, val integrationParametersInternal: EnterpriseCrmFrontendsEventbusProtoWorkflowParametersResponse, val lastModifierEmail: String, val lockHolder: String, val name: String, val origin: String, val parentTemplateId: String, val runAsServiceAccount: String, val snapshotNumber: String, val state: String, val status: String, val taskConfigs: List<GoogleCloudIntegrationsV1alphaTaskConfigResponse>, val taskConfigsInternal: List<EnterpriseCrmFrontendsEventbusProtoTaskConfigResponse>, val teardown: EnterpriseCrmEventbusProtoTeardownResponse, val triggerConfigs: List<GoogleCloudIntegrationsV1alphaTriggerConfigResponse>, val triggerConfigsInternal: List<EnterpriseCrmFrontendsEventbusProtoTriggerConfigResponse>, val updateTime: String, val userLabel: String)
data class GoogleCloudIntegrationsV1alphaAccessTokenResponse(val accessToken: String, val accessTokenExpireTime: String, val refreshToken: String, val refreshTokenExpireTime: String, val tokenType: String)

The access token represents the authorization of a specific application to access specific parts of a user’s data.

The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header.

This message only contains a field of boolean array.

data class GoogleCloudIntegrationsV1alphaClientCertificateResponse(val encryptedPrivateKey: String, val passphrase: String, val sslCertificate: String)

Contains client certificate information

data class GoogleCloudIntegrationsV1alphaCloudSchedulerConfigResponse(val cronTab: String, val errorMessage: String, val location: String, val serviceAccountEmail: String)

Cloud Scheduler Trigger configuration

Configuration detail of coordinate, it used for UI

This message only contains a field of double number array.

data class GoogleCloudIntegrationsV1alphaErrorCatcherConfigResponse(val description: String, val errorCatcherId: String, val errorCatcherNumber: String, val label: String, val position: GoogleCloudIntegrationsV1alphaCoordinateResponse, val startErrorTasks: List<GoogleCloudIntegrationsV1alphaNextTaskResponse>)

Configuration detail of a error catch task

data class GoogleCloudIntegrationsV1alphaFailurePolicyResponse(val intervalTime: String, val maxRetries: Int, val retryStrategy: String)

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).

data class GoogleCloudIntegrationsV1alphaIntegrationAlertConfigResponse(val aggregationPeriod: String, val alertThreshold: Int, val disableAlert: Boolean, val displayName: String, val durationThreshold: String, val metricType: String, val onlyFinalAttempt: Boolean, val thresholdType: String, val thresholdValue: GoogleCloudIntegrationsV1alphaIntegrationAlertConfigThresholdValueResponse)

Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.

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.

data class GoogleCloudIntegrationsV1alphaIntegrationParameterResponse(val dataType: String, val defaultValue: GoogleCloudIntegrationsV1alphaValueTypeResponse, val displayName: String, val inputOutputType: String, val isTransient: Boolean, val jsonSchema: String, val key: String, val producer: String, val searchable: Boolean)

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.

This message only contains a field of integer array.

data class GoogleCloudIntegrationsV1alphaJwtResponse(val jwt: String, val jwtHeader: String, val jwtPayload: String, val secret: String)

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.

data class GoogleCloudIntegrationsV1alphaNextTaskResponse(val condition: String, val description: String, val displayName: String, val taskConfigId: String, val taskId: String)

The task that is next in line to be executed, if the condition specified evaluated to true.

data class GoogleCloudIntegrationsV1alphaOAuth2AuthorizationCodeResponse(val accessToken: GoogleCloudIntegrationsV1alphaAccessTokenResponse, val applyReauthPolicy: Boolean, val authCode: String, val authEndpoint: String, val authParams: GoogleCloudIntegrationsV1alphaParameterMapResponse, val clientId: String, val clientSecret: String, val requestType: String, val scope: String, val tokenEndpoint: String, val tokenParams: GoogleCloudIntegrationsV1alphaParameterMapResponse)

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.

data class GoogleCloudIntegrationsV1alphaOAuth2ClientCredentialsResponse(val accessToken: GoogleCloudIntegrationsV1alphaAccessTokenResponse, val clientId: String, val clientSecret: String, val requestType: String, val scope: String, val tokenEndpoint: String, val tokenParams: GoogleCloudIntegrationsV1alphaParameterMapResponse)

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.

data class GoogleCloudIntegrationsV1alphaOAuth2ResourceOwnerCredentialsResponse(val accessToken: GoogleCloudIntegrationsV1alphaAccessTokenResponse, val clientId: String, val clientSecret: String, val password: String, val requestType: String, val scope: String, val tokenEndpoint: String, val tokenParams: GoogleCloudIntegrationsV1alphaParameterMapResponse, val username: String)

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.

data class GoogleCloudIntegrationsV1alphaOidcTokenResponse(val audience: String, val serviceAccountEmail: String, val token: String, val tokenExpireTime: String)

OIDC Token

Field represents either the key or value in an entry.

A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.

Represents the service account which can be used to generate access token for authenticating the service call.

This message only contains a field of string array.

Policy that dictates the behavior for the task after it completes successfully.

data class GoogleCloudIntegrationsV1alphaTaskConfigResponse(val description: String, val displayName: String, val errorCatcherId: String, val externalTaskType: String, val failurePolicy: GoogleCloudIntegrationsV1alphaFailurePolicyResponse, val jsonValidationOption: String, val nextTasks: List<GoogleCloudIntegrationsV1alphaNextTaskResponse>, val nextTasksExecutionPolicy: String, val parameters: Map<String, String>, val position: GoogleCloudIntegrationsV1alphaCoordinateResponse, val successPolicy: GoogleCloudIntegrationsV1alphaSuccessPolicyResponse, val synchronousCallFailurePolicy: GoogleCloudIntegrationsV1alphaFailurePolicyResponse, val task: String, val taskExecutionStrategy: String, val taskId: String, val taskTemplate: String)

The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.

data class GoogleCloudIntegrationsV1alphaTriggerConfigResponse(val alertConfig: List<GoogleCloudIntegrationsV1alphaIntegrationAlertConfigResponse>, val cloudSchedulerConfig: GoogleCloudIntegrationsV1alphaCloudSchedulerConfigResponse, val description: String, val errorCatcherId: String, val label: String, val nextTasksExecutionPolicy: String, val position: GoogleCloudIntegrationsV1alphaCoordinateResponse, val properties: Map<String, String>, val startTasks: List<GoogleCloudIntegrationsV1alphaNextTaskResponse>, val triggerId: String, val triggerNumber: String, val triggerType: String)

Configuration detail of a trigger.

Username and password pair.