Package-level declarations
Types
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.
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
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).
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.
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).
Represents a node identifier (type + id). Next highest id: 3
Key-value pair of EventBus parameters.
LINT.IfChange To support various types of parameter values. Next available id: 14
Range used to validate doubles and floats.
Range used to validate longs and ints.
Rule used to validate strings.
Key-value pair of EventBus property.
Policy that dictates the behavior for the task after it completes successfully.
Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event.
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.
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.
Used for define type for values. Currently supported value types include int, string, double, array, and any proto message.
Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
Stats for the requested dimensions: QPS, duration, and error/warning rate
Builder for EnterpriseCrmEventbusStatsArgs.
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 parameters.
To support various types of parameter values. Next available id: 14
Key-value pair of EventBus task parameters. Next id: 13
Next available id: 4
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
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.
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
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
Builder for GetAuthConfigPlainArgs.
Builder for GetCertificatePlainArgs.
Builder for GetSfdcChannelPlainArgs.
Builder for GetSfdcInstancePlainArgs.
Builder for GetTemplatesVersionPlainArgs.
Builder for GetVersionPlainArgs.
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.
Contains client certificate information
Cloud Scheduler Trigger configuration
Configuration detail of coordinate, it used for UI
Defines parameters for a single, canonical credential.
This message only contains a field of double number array.
Configuration detail of a error catch task
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).
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.
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.
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.
The task that is next in line to be executed, if the condition specified evaluated to true.
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.
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.
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.
OIDC Token
A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.
Entry is a pair of key and value.
Field represents either the key or value in an entry.
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.
The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
Configuration detail of a trigger.
Username and password pair.
The type of the parameter.