com.google.api.services.integrations.v1alpha.model.EnterpriseCrmFrontendsEventbusProtoTaskConfig Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.integrations.v1alpha.model;
/**
* The task configuration details. This is not the implementation of Task. There might be multiple
* TaskConfigs for the same Task.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Application Integration API. For a detailed
* explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class EnterpriseCrmFrontendsEventbusProtoTaskConfig extends com.google.api.client.json.GenericJson {
/**
* Alert configurations on error rate, warning rate, number of runs, durations, etc.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List alertConfigs;
static {
// hack to force ProGuard to consider EnterpriseCrmEventbusProtoTaskAlertConfig used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(EnterpriseCrmEventbusProtoTaskAlertConfig.class);
}
/**
* Auto-generated.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String createTime;
/**
* The creator's email address. Auto-generated from the user's email.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String creatorEmail;
/**
* User-provided description intended to give more business context about the task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean disableStrictTypeValidation;
/**
* 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.).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmEventbusProtoFailurePolicy failurePolicy;
/**
* The number of edges leading into this TaskConfig.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer incomingEdgeCount;
/**
* If set, overrides the option configured in the Task implementation class.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String jsonValidationOption;
/**
* User-provided label that is attached to this TaskConfig in the UI.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String label;
/**
* Auto-generated.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private String lastModifiedTime;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List nextTasks;
static {
// hack to force ProGuard to consider EnterpriseCrmEventbusProtoNextTask used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(EnterpriseCrmEventbusProtoNextTask.class);
}
/**
* The policy dictating the execution of the next set of tasks for the current task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String nextTasksExecutionPolicy;
/**
* The customized parameters the user can pass to this task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.Map parameters;
static {
// hack to force ProGuard to consider EnterpriseCrmFrontendsEventbusProtoParameterEntry used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(EnterpriseCrmFrontendsEventbusProtoParameterEntry.class);
}
/**
* Optional. Informs the front-end application where to draw this task config on the UI.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmEventbusProtoCoordinate position;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String precondition;
/**
* Optional. User-provided label that is attached to precondition in the UI.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String preconditionLabel;
/**
* Optional. Contains information about what needs to be done upon failure (either a permanent
* error or after it has been retried too many times).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmFrontendsEventbusProtoRollbackStrategy rollbackStrategy;
/**
* Determines what action to take upon successful task completion.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmEventbusProtoSuccessPolicy successPolicy;
/**
* 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).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmEventbusProtoFailurePolicy synchronousCallFailurePolicy;
/**
* Copy of the task entity that this task config is an instance of.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private EnterpriseCrmFrontendsEventbusProtoTaskEntity taskEntity;
/**
* The policy dictating the execution strategy of this task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String taskExecutionStrategy;
/**
* The name for the task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String taskName;
/**
* 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`).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String taskNumber;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String taskSpec;
/**
* Used to define task-template name if task is of type task-template
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String taskTemplateName;
/**
* Defines the type of the task
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String taskType;
/**
* Alert configurations on error rate, warning rate, number of runs, durations, etc.
* @return value or {@code null} for none
*/
public java.util.List getAlertConfigs() {
return alertConfigs;
}
/**
* Alert configurations on error rate, warning rate, number of runs, durations, etc.
* @param alertConfigs alertConfigs or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setAlertConfigs(java.util.List alertConfigs) {
this.alertConfigs = alertConfigs;
return this;
}
/**
* Auto-generated.
* @return value or {@code null} for none
*/
public String getCreateTime() {
return createTime;
}
/**
* Auto-generated.
* @param createTime createTime or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setCreateTime(String createTime) {
this.createTime = createTime;
return this;
}
/**
* The creator's email address. Auto-generated from the user's email.
* @return value or {@code null} for none
*/
public java.lang.String getCreatorEmail() {
return creatorEmail;
}
/**
* The creator's email address. Auto-generated from the user's email.
* @param creatorEmail creatorEmail or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setCreatorEmail(java.lang.String creatorEmail) {
this.creatorEmail = creatorEmail;
return this;
}
/**
* User-provided description intended to give more business context about the task.
* @return value or {@code null} for none
*/
public java.lang.String getDescription() {
return description;
}
/**
* User-provided description intended to give more business context about the task.
* @param description description or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.Boolean getDisableStrictTypeValidation() {
return disableStrictTypeValidation;
}
/**
* 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.
* @param disableStrictTypeValidation disableStrictTypeValidation or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setDisableStrictTypeValidation(java.lang.Boolean disableStrictTypeValidation) {
this.disableStrictTypeValidation = disableStrictTypeValidation;
return this;
}
/**
* 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.).
* @return value or {@code null} for none
*/
public EnterpriseCrmEventbusProtoFailurePolicy getFailurePolicy() {
return failurePolicy;
}
/**
* 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.).
* @param failurePolicy failurePolicy or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setFailurePolicy(EnterpriseCrmEventbusProtoFailurePolicy failurePolicy) {
this.failurePolicy = failurePolicy;
return this;
}
/**
* The number of edges leading into this TaskConfig.
* @return value or {@code null} for none
*/
public java.lang.Integer getIncomingEdgeCount() {
return incomingEdgeCount;
}
/**
* The number of edges leading into this TaskConfig.
* @param incomingEdgeCount incomingEdgeCount or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setIncomingEdgeCount(java.lang.Integer incomingEdgeCount) {
this.incomingEdgeCount = incomingEdgeCount;
return this;
}
/**
* If set, overrides the option configured in the Task implementation class.
* @return value or {@code null} for none
*/
public java.lang.String getJsonValidationOption() {
return jsonValidationOption;
}
/**
* If set, overrides the option configured in the Task implementation class.
* @param jsonValidationOption jsonValidationOption or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setJsonValidationOption(java.lang.String jsonValidationOption) {
this.jsonValidationOption = jsonValidationOption;
return this;
}
/**
* User-provided label that is attached to this TaskConfig in the UI.
* @return value or {@code null} for none
*/
public java.lang.String getLabel() {
return label;
}
/**
* User-provided label that is attached to this TaskConfig in the UI.
* @param label label or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setLabel(java.lang.String label) {
this.label = label;
return this;
}
/**
* Auto-generated.
* @return value or {@code null} for none
*/
public String getLastModifiedTime() {
return lastModifiedTime;
}
/**
* Auto-generated.
* @param lastModifiedTime lastModifiedTime or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setLastModifiedTime(String lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.util.List getNextTasks() {
return nextTasks;
}
/**
* 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.
* @param nextTasks nextTasks or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setNextTasks(java.util.List nextTasks) {
this.nextTasks = nextTasks;
return this;
}
/**
* The policy dictating the execution of the next set of tasks for the current task.
* @return value or {@code null} for none
*/
public java.lang.String getNextTasksExecutionPolicy() {
return nextTasksExecutionPolicy;
}
/**
* The policy dictating the execution of the next set of tasks for the current task.
* @param nextTasksExecutionPolicy nextTasksExecutionPolicy or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setNextTasksExecutionPolicy(java.lang.String nextTasksExecutionPolicy) {
this.nextTasksExecutionPolicy = nextTasksExecutionPolicy;
return this;
}
/**
* The customized parameters the user can pass to this task.
* @return value or {@code null} for none
*/
public java.util.Map getParameters() {
return parameters;
}
/**
* The customized parameters the user can pass to this task.
* @param parameters parameters or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setParameters(java.util.Map parameters) {
this.parameters = parameters;
return this;
}
/**
* Optional. Informs the front-end application where to draw this task config on the UI.
* @return value or {@code null} for none
*/
public EnterpriseCrmEventbusProtoCoordinate getPosition() {
return position;
}
/**
* Optional. Informs the front-end application where to draw this task config on the UI.
* @param position position or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setPosition(EnterpriseCrmEventbusProtoCoordinate position) {
this.position = position;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getPrecondition() {
return precondition;
}
/**
* 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.
* @param precondition precondition or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setPrecondition(java.lang.String precondition) {
this.precondition = precondition;
return this;
}
/**
* Optional. User-provided label that is attached to precondition in the UI.
* @return value or {@code null} for none
*/
public java.lang.String getPreconditionLabel() {
return preconditionLabel;
}
/**
* Optional. User-provided label that is attached to precondition in the UI.
* @param preconditionLabel preconditionLabel or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setPreconditionLabel(java.lang.String preconditionLabel) {
this.preconditionLabel = preconditionLabel;
return this;
}
/**
* Optional. Contains information about what needs to be done upon failure (either a permanent
* error or after it has been retried too many times).
* @return value or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoRollbackStrategy getRollbackStrategy() {
return rollbackStrategy;
}
/**
* Optional. Contains information about what needs to be done upon failure (either a permanent
* error or after it has been retried too many times).
* @param rollbackStrategy rollbackStrategy or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setRollbackStrategy(EnterpriseCrmFrontendsEventbusProtoRollbackStrategy rollbackStrategy) {
this.rollbackStrategy = rollbackStrategy;
return this;
}
/**
* Determines what action to take upon successful task completion.
* @return value or {@code null} for none
*/
public EnterpriseCrmEventbusProtoSuccessPolicy getSuccessPolicy() {
return successPolicy;
}
/**
* Determines what action to take upon successful task completion.
* @param successPolicy successPolicy or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setSuccessPolicy(EnterpriseCrmEventbusProtoSuccessPolicy successPolicy) {
this.successPolicy = successPolicy;
return this;
}
/**
* 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).
* @return value or {@code null} for none
*/
public EnterpriseCrmEventbusProtoFailurePolicy getSynchronousCallFailurePolicy() {
return synchronousCallFailurePolicy;
}
/**
* 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).
* @param synchronousCallFailurePolicy synchronousCallFailurePolicy or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setSynchronousCallFailurePolicy(EnterpriseCrmEventbusProtoFailurePolicy synchronousCallFailurePolicy) {
this.synchronousCallFailurePolicy = synchronousCallFailurePolicy;
return this;
}
/**
* Copy of the task entity that this task config is an instance of.
* @return value or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskEntity getTaskEntity() {
return taskEntity;
}
/**
* Copy of the task entity that this task config is an instance of.
* @param taskEntity taskEntity or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setTaskEntity(EnterpriseCrmFrontendsEventbusProtoTaskEntity taskEntity) {
this.taskEntity = taskEntity;
return this;
}
/**
* The policy dictating the execution strategy of this task.
* @return value or {@code null} for none
*/
public java.lang.String getTaskExecutionStrategy() {
return taskExecutionStrategy;
}
/**
* The policy dictating the execution strategy of this task.
* @param taskExecutionStrategy taskExecutionStrategy or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setTaskExecutionStrategy(java.lang.String taskExecutionStrategy) {
this.taskExecutionStrategy = taskExecutionStrategy;
return this;
}
/**
* The name for the task.
* @return value or {@code null} for none
*/
public java.lang.String getTaskName() {
return taskName;
}
/**
* The name for the task.
* @param taskName taskName or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setTaskName(java.lang.String taskName) {
this.taskName = taskName;
return this;
}
/**
* 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`).
* @return value or {@code null} for none
*/
public java.lang.String getTaskNumber() {
return taskNumber;
}
/**
* 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`).
* @param taskNumber taskNumber or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setTaskNumber(java.lang.String taskNumber) {
this.taskNumber = taskNumber;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getTaskSpec() {
return taskSpec;
}
/**
* 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.
* @param taskSpec taskSpec or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setTaskSpec(java.lang.String taskSpec) {
this.taskSpec = taskSpec;
return this;
}
/**
* Used to define task-template name if task is of type task-template
* @return value or {@code null} for none
*/
public java.lang.String getTaskTemplateName() {
return taskTemplateName;
}
/**
* Used to define task-template name if task is of type task-template
* @param taskTemplateName taskTemplateName or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setTaskTemplateName(java.lang.String taskTemplateName) {
this.taskTemplateName = taskTemplateName;
return this;
}
/**
* Defines the type of the task
* @return value or {@code null} for none
*/
public java.lang.String getTaskType() {
return taskType;
}
/**
* Defines the type of the task
* @param taskType taskType or {@code null} for none
*/
public EnterpriseCrmFrontendsEventbusProtoTaskConfig setTaskType(java.lang.String taskType) {
this.taskType = taskType;
return this;
}
@Override
public EnterpriseCrmFrontendsEventbusProtoTaskConfig set(String fieldName, Object value) {
return (EnterpriseCrmFrontendsEventbusProtoTaskConfig) super.set(fieldName, value);
}
@Override
public EnterpriseCrmFrontendsEventbusProtoTaskConfig clone() {
return (EnterpriseCrmFrontendsEventbusProtoTaskConfig) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy