jp.co.yahoo.adssearchapi.v12.model.CampaignExportServiceJob Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ads-search-api-lib Show documentation
Yahoo! JAPAN Ads Search Ads API library for Java
The newest version!
/*
 * Yahoo!広告 検索広告 API リファレンス / Yahoo! JAPAN Ads Search Ads API Reference
 * Yahoo!広告 検索広告 APIのWebサービスについて説明します。
 Search Ads API Web Services supported in Yahoo! JAPAN Ads API.
 OpenAPI Specification
 Best Practice
 Best Practice 
 *
 * The version of the OpenAPI document: v12
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package jp.co.yahoo.adssearchapi.v12.model;

import java.util.Objects;
import java.util.Arrays;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import jp.co.yahoo.adssearchapi.v12.model.CampaignExportServiceJobStatus;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">CampaignExportServiceJob オブジェクトは、ジョブの情報を表します。</div> <div lang=\"en\">CampaignExportServiceJob object describes the information of job settings.</div> 
 */
@ApiModel(description = "CampaignExportServiceJob オブジェクトは、ジョブの情報を表します。
 CampaignExportServiceJob object describes the information of job settings. ")
@JsonPropertyOrder({
  CampaignExportServiceJob.JSON_PROPERTY_ACCOUNT_ID,
  CampaignExportServiceJob.JSON_PROPERTY_END_DATE,
  CampaignExportServiceJob.JSON_PROPERTY_EXPORT_FIELDS,
  CampaignExportServiceJob.JSON_PROPERTY_JOB_ID,
  CampaignExportServiceJob.JSON_PROPERTY_JOB_NAME,
  CampaignExportServiceJob.JSON_PROPERTY_JOB_STATUS,
  CampaignExportServiceJob.JSON_PROPERTY_PROGRESS,
  CampaignExportServiceJob.JSON_PROPERTY_START_DATE,
  CampaignExportServiceJob.JSON_PROPERTY_USER_NAME
})
@JsonTypeName("CampaignExportServiceJob")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class CampaignExportServiceJob {
  public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
  private Long accountId;

  public static final String JSON_PROPERTY_END_DATE = "endDate";
  private String endDate;

  public static final String JSON_PROPERTY_EXPORT_FIELDS = "exportFields";
  private List exportFields = null;

  public static final String JSON_PROPERTY_JOB_ID = "jobId";
  private Long jobId;

  public static final String JSON_PROPERTY_JOB_NAME = "jobName";
  private String jobName;

  public static final String JSON_PROPERTY_JOB_STATUS = "jobStatus";
  private CampaignExportServiceJobStatus jobStatus;

  public static final String JSON_PROPERTY_PROGRESS = "progress";
  private Integer progress;

  public static final String JSON_PROPERTY_START_DATE = "startDate";
  private String startDate;

  public static final String JSON_PROPERTY_USER_NAME = "userName";
  private String userName;

  public CampaignExportServiceJob() { 
  }

  public CampaignExportServiceJob accountId(Long accountId) {
    
    this.accountId = accountId;
    return this;
  }

   /**
   * <div lang=\"ja\">アカウントIDです。</div> <div lang=\"en\">Account ID.</div> 
   * @return accountId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "アカウントIDです。
 Account ID. ")
  @JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getAccountId() {
    return accountId;
  }


  @JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAccountId(Long accountId) {
    this.accountId = accountId;
  }


  public CampaignExportServiceJob endDate(String endDate) {
    
    this.endDate = endDate;
    return this;
  }

   /**
   * <div lang=\"ja\">ジョブの終了日時です。</div> <div lang=\"en\">End date and time of job setting.</div> 
   * @return endDate
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ジョブの終了日時です。
 End date and time of job setting. ")
  @JsonProperty(JSON_PROPERTY_END_DATE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getEndDate() {
    return endDate;
  }


  @JsonProperty(JSON_PROPERTY_END_DATE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setEndDate(String endDate) {
    this.endDate = endDate;
  }


  public CampaignExportServiceJob exportFields(List exportFields) {
    
    this.exportFields = exportFields;
    return this;
  }

  public CampaignExportServiceJob addExportFieldsItem(String exportFieldsItem) {
    if (this.exportFields == null) {
      this.exportFields = new ArrayList<>();
    }
    this.exportFields.add(exportFieldsItem);
    return this;
  }

   /**
   * <div lang=\"ja\">エクスポートするフィールドです。</div> <div lang=\"en\">Fields to be exported.</div> 
   * @return exportFields
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "エクスポートするフィールドです。
 Fields to be exported. ")
  @JsonProperty(JSON_PROPERTY_EXPORT_FIELDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getExportFields() {
    return exportFields;
  }


  @JsonProperty(JSON_PROPERTY_EXPORT_FIELDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setExportFields(List exportFields) {
    this.exportFields = exportFields;
  }


  public CampaignExportServiceJob jobId(Long jobId) {
    
    this.jobId = jobId;
    return this;
  }

   /**
   * <div lang=\"ja\">ジョブIDです。</div> <div lang=\"en\">CampaignExportServiceJob ID.</div> 
   * @return jobId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ジョブIDです。
 CampaignExportServiceJob ID. ")
  @JsonProperty(JSON_PROPERTY_JOB_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getJobId() {
    return jobId;
  }


  @JsonProperty(JSON_PROPERTY_JOB_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setJobId(Long jobId) {
    this.jobId = jobId;
  }


  public CampaignExportServiceJob jobName(String jobName) {
    
    this.jobName = jobName;
    return this;
  }

   /**
   * <div lang=\"ja\">ジョブ名です。</div> <div lang=\"en\">CampaignExportServiceJob name.<br> ∗ Default: NULL</div> 
   * @return jobName
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ジョブ名です。
 CampaignExportServiceJob name.
 ∗ Default: NULL ")
  @JsonProperty(JSON_PROPERTY_JOB_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getJobName() {
    return jobName;
  }


  @JsonProperty(JSON_PROPERTY_JOB_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setJobName(String jobName) {
    this.jobName = jobName;
  }


  public CampaignExportServiceJob jobStatus(CampaignExportServiceJobStatus jobStatus) {
    
    this.jobStatus = jobStatus;
    return this;
  }

   /**
   * Get jobStatus
   * @return jobStatus
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "")
  @JsonProperty(JSON_PROPERTY_JOB_STATUS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public CampaignExportServiceJobStatus getJobStatus() {
    return jobStatus;
  }


  @JsonProperty(JSON_PROPERTY_JOB_STATUS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setJobStatus(CampaignExportServiceJobStatus jobStatus) {
    this.jobStatus = jobStatus;
  }


  public CampaignExportServiceJob progress(Integer progress) {
    
    this.progress = progress;
    return this;
  }

   /**
   * <div lang=\"ja\">処理進捗です。</div> <div lang=\"en\">Progress of job setting.</div> 
   * @return progress
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "処理進捗です。
 Progress of job setting. ")
  @JsonProperty(JSON_PROPERTY_PROGRESS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Integer getProgress() {
    return progress;
  }


  @JsonProperty(JSON_PROPERTY_PROGRESS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setProgress(Integer progress) {
    this.progress = progress;
  }


  public CampaignExportServiceJob startDate(String startDate) {
    
    this.startDate = startDate;
    return this;
  }

   /**
   * <div lang=\"ja\">ジョブの開始日時です。</div> <div lang=\"en\">Start date and time of job setting.</div> 
   * @return startDate
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ジョブの開始日時です。
 Start date and time of job setting. ")
  @JsonProperty(JSON_PROPERTY_START_DATE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getStartDate() {
    return startDate;
  }


  @JsonProperty(JSON_PROPERTY_START_DATE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setStartDate(String startDate) {
    this.startDate = startDate;
  }


  public CampaignExportServiceJob userName(String userName) {
    
    this.userName = userName;
    return this;
  }

   /**
   * <div lang=\"ja\">ジョブ実行者のユーザー名です。</div> <div lang=\"en\">Name of user who run the job.</div> 
   * @return userName
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ジョブ実行者のユーザー名です。
 Name of user who run the job. ")
  @JsonProperty(JSON_PROPERTY_USER_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getUserName() {
    return userName;
  }


  @JsonProperty(JSON_PROPERTY_USER_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setUserName(String userName) {
    this.userName = userName;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    CampaignExportServiceJob campaignExportServiceJob = (CampaignExportServiceJob) o;
    return Objects.equals(this.accountId, campaignExportServiceJob.accountId) &&
        Objects.equals(this.endDate, campaignExportServiceJob.endDate) &&
        Objects.equals(this.exportFields, campaignExportServiceJob.exportFields) &&
        Objects.equals(this.jobId, campaignExportServiceJob.jobId) &&
        Objects.equals(this.jobName, campaignExportServiceJob.jobName) &&
        Objects.equals(this.jobStatus, campaignExportServiceJob.jobStatus) &&
        Objects.equals(this.progress, campaignExportServiceJob.progress) &&
        Objects.equals(this.startDate, campaignExportServiceJob.startDate) &&
        Objects.equals(this.userName, campaignExportServiceJob.userName);
  }

  @Override
  public int hashCode() {
    return Objects.hash(accountId, endDate, exportFields, jobId, jobName, jobStatus, progress, startDate, userName);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class CampaignExportServiceJob {\n");
    sb.append("    accountId: ").append(toIndentedString(accountId)).append("\n");
    sb.append("    endDate: ").append(toIndentedString(endDate)).append("\n");
    sb.append("    exportFields: ").append(toIndentedString(exportFields)).append("\n");
    sb.append("    jobId: ").append(toIndentedString(jobId)).append("\n");
    sb.append("    jobName: ").append(toIndentedString(jobName)).append("\n");
    sb.append("    jobStatus: ").append(toIndentedString(jobStatus)).append("\n");
    sb.append("    progress: ").append(toIndentedString(progress)).append("\n");
    sb.append("    startDate: ").append(toIndentedString(startDate)).append("\n");
    sb.append("    userName: ").append(toIndentedString(userName)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces
   * (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }

}