com.google.api.services.integrations.v1alpha.model.GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest Maven / Gradle / Ivy

Go to download
/*
 * 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 request for executing an integration.
 *
 *  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 GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest extends com.google.api.client.json.GenericJson {

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean doNotPropagateError;

  /**
   * Optional. The id of the ON_HOLD execution to be resumed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String executionId;

  /**
   * Optional. Input parameters used by integration execution.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map inputParameters;

  /**
   * Optional. Parameters are a part of Event and can be used to communicate between different tasks
   * that are part of the same integration execution.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List parameterEntries;

  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. Passed in as parameters to each integration execution. Redacted
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private EnterpriseCrmFrontendsEventbusProtoEventParameters parameters;

  /**
   * Optional. This is used to de-dup incoming request: if the duplicate request was detected, the
   * response from the previous execution is returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String requestId;

  /**
   * 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`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String triggerId;

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDoNotPropagateError() {
    return doNotPropagateError;
  }

  /**
   * 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.
   * @param doNotPropagateError doNotPropagateError or {@code null} for none
   */
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest setDoNotPropagateError(java.lang.Boolean doNotPropagateError) {
    this.doNotPropagateError = doNotPropagateError;
    return this;
  }

  /**
   * Optional. The id of the ON_HOLD execution to be resumed.
   * @return value or {@code null} for none
   */
  public java.lang.String getExecutionId() {
    return executionId;
  }

  /**
   * Optional. The id of the ON_HOLD execution to be resumed.
   * @param executionId executionId or {@code null} for none
   */
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest setExecutionId(java.lang.String executionId) {
    this.executionId = executionId;
    return this;
  }

  /**
   * Optional. Input parameters used by integration execution.
   * @return value or {@code null} for none
   */
  public java.util.Map getInputParameters() {
    return inputParameters;
  }

  /**
   * Optional. Input parameters used by integration execution.
   * @param inputParameters inputParameters or {@code null} for none
   */
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest setInputParameters(java.util.Map inputParameters) {
    this.inputParameters = inputParameters;
    return this;
  }

  /**
   * Optional. Parameters are a part of Event and can be used to communicate between different tasks
   * that are part of the same integration execution.
   * @return value or {@code null} for none
   */
  public java.util.List getParameterEntries() {
    return parameterEntries;
  }

  /**
   * Optional. Parameters are a part of Event and can be used to communicate between different tasks
   * that are part of the same integration execution.
   * @param parameterEntries parameterEntries or {@code null} for none
   */
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest setParameterEntries(java.util.List parameterEntries) {
    this.parameterEntries = parameterEntries;
    return this;
  }

  /**
   * Optional. Passed in as parameters to each integration execution. Redacted
   * @return value or {@code null} for none
   */
  public EnterpriseCrmFrontendsEventbusProtoEventParameters getParameters() {
    return parameters;
  }

  /**
   * Optional. Passed in as parameters to each integration execution. Redacted
   * @param parameters parameters or {@code null} for none
   */
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest setParameters(EnterpriseCrmFrontendsEventbusProtoEventParameters parameters) {
    this.parameters = parameters;
    return this;
  }

  /**
   * Optional. This is used to de-dup incoming request: if the duplicate request was detected, the
   * response from the previous execution is returned.
   * @return value or {@code null} for none
   */
  public java.lang.String getRequestId() {
    return requestId;
  }

  /**
   * Optional. This is used to de-dup incoming request: if the duplicate request was detected, the
   * response from the previous execution is returned.
   * @param requestId requestId or {@code null} for none
   */
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest setRequestId(java.lang.String requestId) {
    this.requestId = requestId;
    return this;
  }

  /**
   * 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`.
   * @return value or {@code null} for none
   */
  public java.lang.String getTriggerId() {
    return triggerId;
  }

  /**
   * 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`.
   * @param triggerId triggerId or {@code null} for none
   */
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest setTriggerId(java.lang.String triggerId) {
    this.triggerId = triggerId;
    return this;
  }

  @Override
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest set(String fieldName, Object value) {
    return (GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest clone() {
    return (GoogleCloudIntegrationsV1alphaExecuteIntegrationsRequest) super.clone();
  }

}