jp.co.yahoo.adssearchapi.v13.model.CampaignServiceBudget 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: v13
 * 
 *
 * 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.v13.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 com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">CampaignServiceBudgetオブジェクトは、キャンペーン予算に関する情報を表します。<br> このフィールドは、ADD時に必須となり、SET時は省略可能となります。</div> <div lang=\"en\">CampaignServiceBudget object displays budget information for campaign.<br> This field is required in ADD operation, and will be optional in SET operation.</div> 
 */
@ApiModel(description = "CampaignServiceBudgetオブジェクトは、キャンペーン予算に関する情報を表します。
 このフィールドは、ADD時に必須となり、SET時は省略可能となります。
 CampaignServiceBudget object displays budget information for campaign.
 This field is required in ADD operation, and will be optional in SET operation. ")
@JsonPropertyOrder({
  CampaignServiceBudget.JSON_PROPERTY_AMOUNT,
  CampaignServiceBudget.JSON_PROPERTY_CAMPAIGN_BUDGET_ID,
  CampaignServiceBudget.JSON_PROPERTY_CAMPAIGN_BUDGET_NAME
})
@JsonTypeName("CampaignServiceBudget")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class CampaignServiceBudget {
  public static final String JSON_PROPERTY_AMOUNT = "amount";
  private Long amount;

  public static final String JSON_PROPERTY_CAMPAIGN_BUDGET_ID = "campaignBudgetId";
  private Long campaignBudgetId;

  public static final String JSON_PROPERTY_CAMPAIGN_BUDGET_NAME = "campaignBudgetName";
  private String campaignBudgetName;

  public CampaignServiceBudget() { 
  }

  public CampaignServiceBudget amount(Long amount) {
    
    this.amount = amount;
    return this;
  }

   /**
   * <div lang=\"ja\">1日単位のキャンペーン予算利用金額です。<br> ADDおよびSET時、個別予算を設定する場合、このフィールドは必須となり、共有予算を設定する場合、設定不可となります。また、campaignBudgetIdと同時に設定することはできません。</div> <div lang=\"en\">Amount of budget of Campaign.<br> In ADD and SET operation, this field is required when setting individual budgets, and is not allowed when setting shared budgets. This field cannot be set at the same time as campaignBudgetId.</div> 
   * @return amount
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "1日単位のキャンペーン予算利用金額です。
 ADDおよびSET時、個別予算を設定する場合、このフィールドは必須となり、共有予算を設定する場合、設定不可となります。また、campaignBudgetIdと同時に設定することはできません。
 Amount of budget of Campaign.
 In ADD and SET operation, this field is required when setting individual budgets, and is not allowed when setting shared budgets. This field cannot be set at the same time as campaignBudgetId. ")
  @JsonProperty(JSON_PROPERTY_AMOUNT)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getAmount() {
    return amount;
  }


  @JsonProperty(JSON_PROPERTY_AMOUNT)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAmount(Long amount) {
    this.amount = amount;
  }


  public CampaignServiceBudget campaignBudgetId(Long campaignBudgetId) {
    
    this.campaignBudgetId = campaignBudgetId;
    return this;
  }

   /**
   * <div lang=\"ja\">共有予算IDです。<br> ADDおよびSET時、個別予算を設定する場合、このフィールドは設定不可となり、共有予算を設定する場合、必須となります。また、amountと同時に設定することはできません。</div> <div lang=\"en\">CampaignBudget ID.<br> In ADD and SET operation, this field is not allowed when setting individual budgets, and is required when setting shared budgets. This field cannot be set at the same time as amount.</div> 
   * @return campaignBudgetId
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "共有予算IDです。
 ADDおよびSET時、個別予算を設定する場合、このフィールドは設定不可となり、共有予算を設定する場合、必須となります。また、amountと同時に設定することはできません。
 CampaignBudget ID.
 In ADD and SET operation, this field is not allowed when setting individual budgets, and is required when setting shared budgets. This field cannot be set at the same time as amount. ")
  @JsonProperty(JSON_PROPERTY_CAMPAIGN_BUDGET_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Long getCampaignBudgetId() {
    return campaignBudgetId;
  }


  @JsonProperty(JSON_PROPERTY_CAMPAIGN_BUDGET_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCampaignBudgetId(Long campaignBudgetId) {
    this.campaignBudgetId = campaignBudgetId;
  }


  public CampaignServiceBudget campaignBudgetName(String campaignBudgetName) {
    
    this.campaignBudgetName = campaignBudgetName;
    return this;
  }

   /**
   * <div lang=\"ja\">共有予算名です。<br> ADDおよびSET時、このフィールドは無視されます。</div> <div lang=\"en\">CampaignBudget name.<br> This field will be ignored in ADD and SET operation.</div> 
   * @return campaignBudgetName
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "共有予算名です。
 ADDおよびSET時、このフィールドは無視されます。
 CampaignBudget name.
 This field will be ignored in ADD and SET operation. ")
  @JsonProperty(JSON_PROPERTY_CAMPAIGN_BUDGET_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getCampaignBudgetName() {
    return campaignBudgetName;
  }


  @JsonProperty(JSON_PROPERTY_CAMPAIGN_BUDGET_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCampaignBudgetName(String campaignBudgetName) {
    this.campaignBudgetName = campaignBudgetName;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    CampaignServiceBudget campaignServiceBudget = (CampaignServiceBudget) o;
    return Objects.equals(this.amount, campaignServiceBudget.amount) &&
        Objects.equals(this.campaignBudgetId, campaignServiceBudget.campaignBudgetId) &&
        Objects.equals(this.campaignBudgetName, campaignServiceBudget.campaignBudgetName);
  }

  @Override
  public int hashCode() {
    return Objects.hash(amount, campaignBudgetId, campaignBudgetName);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class CampaignServiceBudget {\n");
    sb.append("    amount: ").append(toIndentedString(amount)).append("\n");
    sb.append("    campaignBudgetId: ").append(toIndentedString(campaignBudgetId)).append("\n");
    sb.append("    campaignBudgetName: ").append(toIndentedString(campaignBudgetName)).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    ");
  }

}