com.google.api.services.integrations.v1alpha.model.EnterpriseCrmEventbusProtoLoopMetadata 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;

/**
 * Model definition for EnterpriseCrmEventbusProtoLoopMetadata.
 *
 *  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 EnterpriseCrmEventbusProtoLoopMetadata extends com.google.api.client.json.GenericJson {

  /**
   * Starting from 1, not 0.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long currentIterationCount;

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

  /**
   * Add the error message when loops fail.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String errorMsg;

  /**
   * Indicates where in the loop logic did it error out.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String failureLocation;

  /**
   * Starting from 1, not 0.
   * @return value or {@code null} for none
   */
  public java.lang.Long getCurrentIterationCount() {
    return currentIterationCount;
  }

  /**
   * Starting from 1, not 0.
   * @param currentIterationCount currentIterationCount or {@code null} for none
   */
  public EnterpriseCrmEventbusProtoLoopMetadata setCurrentIterationCount(java.lang.Long currentIterationCount) {
    this.currentIterationCount = currentIterationCount;
    return this;
  }

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

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

  /**
   * Add the error message when loops fail.
   * @return value or {@code null} for none
   */
  public java.lang.String getErrorMsg() {
    return errorMsg;
  }

  /**
   * Add the error message when loops fail.
   * @param errorMsg errorMsg or {@code null} for none
   */
  public EnterpriseCrmEventbusProtoLoopMetadata setErrorMsg(java.lang.String errorMsg) {
    this.errorMsg = errorMsg;
    return this;
  }

  /**
   * Indicates where in the loop logic did it error out.
   * @return value or {@code null} for none
   */
  public java.lang.String getFailureLocation() {
    return failureLocation;
  }

  /**
   * Indicates where in the loop logic did it error out.
   * @param failureLocation failureLocation or {@code null} for none
   */
  public EnterpriseCrmEventbusProtoLoopMetadata setFailureLocation(java.lang.String failureLocation) {
    this.failureLocation = failureLocation;
    return this;
  }

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

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

}