jp.co.yahoo.adsdisplayapi.v13.model.SearchKeywordIdeaServiceSelector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ads-display-api-lib Show documentation
Yahoo! JAPAN Ads Display Ads API library for Java
The newest version!
/*
 * Yahoo!広告 ディスプレイ広告 API リファレンス / Yahoo! JAPAN Ads Display Ads API Reference
 * Yahoo!広告 ディスプレイ広告 APIのWebサービスについて説明します。
 Display 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.adsdisplayapi.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 java.util.ArrayList;
import java.util.List;
import jp.co.yahoo.adsdisplayapi.v13.model.SearchKeywordIdeaServiceAvailabilityStatus;
import jp.co.yahoo.adsdisplayapi.v13.model.SearchKeywordIdeaServiceKeywordFrequency;
import jp.co.yahoo.adsdisplayapi.v13.model.SearchKeywordIdeaServiceKeywordRecency;
import jp.co.yahoo.adsdisplayapi.v13.model.SearchKeywordIdeaServiceMatchType;
import jp.co.yahoo.adsdisplayapi.v13.model.SearchKeywordIdeaServiceSortField;
import jp.co.yahoo.adsdisplayapi.v13.model.SearchKeywordIdeaServiceSortType;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">SearchKeywordIdeaServiceSelectorオブジェクトは、サーチターゲティング対象キーワードのリストを表します。</div> <div lang=\"en\">SearchKeywordIdeaServiceSelector object displays the list of keyword for search targeting.</div> 
 */
@ApiModel(description = "SearchKeywordIdeaServiceSelectorオブジェクトは、サーチターゲティング対象キーワードのリストを表します。
 SearchKeywordIdeaServiceSelector object displays the list of keyword for search targeting. ")
@JsonPropertyOrder({
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_KEYWORD_FREQUENCY,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_KEYWORD_IDS,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_KEYWORD_RECENCY,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_KEYWORDS,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_MATCH_TYPE,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_SORT_FIELD,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_SORT_TYPE,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_NUMBER_RESULTS,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_START_INDEX,
  SearchKeywordIdeaServiceSelector.JSON_PROPERTY_AVAILABILITY_STATUS
})
@JsonTypeName("SearchKeywordIdeaServiceSelector")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class SearchKeywordIdeaServiceSelector {
  public static final String JSON_PROPERTY_KEYWORD_FREQUENCY = "keywordFrequency";
  private SearchKeywordIdeaServiceKeywordFrequency keywordFrequency;

  public static final String JSON_PROPERTY_KEYWORD_IDS = "keywordIds";
  private List keywordIds = null;

  public static final String JSON_PROPERTY_KEYWORD_RECENCY = "keywordRecency";
  private SearchKeywordIdeaServiceKeywordRecency keywordRecency;

  public static final String JSON_PROPERTY_KEYWORDS = "keywords";
  private List keywords = null;

  public static final String JSON_PROPERTY_MATCH_TYPE = "matchType";
  private SearchKeywordIdeaServiceMatchType matchType;

  public static final String JSON_PROPERTY_SORT_FIELD = "sortField";
  private SearchKeywordIdeaServiceSortField sortField;

  public static final String JSON_PROPERTY_SORT_TYPE = "sortType";
  private SearchKeywordIdeaServiceSortType sortType;

  public static final String JSON_PROPERTY_NUMBER_RESULTS = "numberResults";
  private Integer numberResults = 1000;

  public static final String JSON_PROPERTY_START_INDEX = "startIndex";
  private Integer startIndex = 1;

  public static final String JSON_PROPERTY_AVAILABILITY_STATUS = "availabilityStatus";
  private SearchKeywordIdeaServiceAvailabilityStatus availabilityStatus;

  public SearchKeywordIdeaServiceSelector() { 
  }

  public SearchKeywordIdeaServiceSelector keywordFrequency(SearchKeywordIdeaServiceKeywordFrequency keywordFrequency) {
    
    this.keywordFrequency = keywordFrequency;
    return this;
  }

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

  public SearchKeywordIdeaServiceKeywordFrequency getKeywordFrequency() {
    return keywordFrequency;
  }


  @JsonProperty(JSON_PROPERTY_KEYWORD_FREQUENCY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setKeywordFrequency(SearchKeywordIdeaServiceKeywordFrequency keywordFrequency) {
    this.keywordFrequency = keywordFrequency;
  }


  public SearchKeywordIdeaServiceSelector keywordIds(List keywordIds) {
    
    this.keywordIds = keywordIds;
    return this;
  }

  public SearchKeywordIdeaServiceSelector addKeywordIdsItem(Long keywordIdsItem) {
    if (this.keywordIds == null) {
      this.keywordIds = new ArrayList<>();
    }
    this.keywordIds.add(keywordIdsItem);
    return this;
  }

   /**
   * <div lang=\"ja\"> 検索条件：キーワードID<br> ※キーワード検索用<br> ※キーワード、キーワードIDの同時指定はできません。 </div> <div lang=\"en\">Search condition : Keyword ID.<br> *Keyword for searching.<br> *Can not specify Keyword and Keyword ID at the same time. </div> 
   * @return keywordIds
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " 検索条件：キーワードID
 ※キーワード検索用
 ※キーワード、キーワードIDの同時指定はできません。 
 Search condition : Keyword ID.
 *Keyword for searching.
 *Can not specify Keyword and Keyword ID at the same time.  ")
  @JsonProperty(JSON_PROPERTY_KEYWORD_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getKeywordIds() {
    return keywordIds;
  }


  @JsonProperty(JSON_PROPERTY_KEYWORD_IDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setKeywordIds(List keywordIds) {
    this.keywordIds = keywordIds;
  }


  public SearchKeywordIdeaServiceSelector keywordRecency(SearchKeywordIdeaServiceKeywordRecency keywordRecency) {
    
    this.keywordRecency = keywordRecency;
    return this;
  }

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

  public SearchKeywordIdeaServiceKeywordRecency getKeywordRecency() {
    return keywordRecency;
  }


  @JsonProperty(JSON_PROPERTY_KEYWORD_RECENCY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setKeywordRecency(SearchKeywordIdeaServiceKeywordRecency keywordRecency) {
    this.keywordRecency = keywordRecency;
  }


  public SearchKeywordIdeaServiceSelector keywords(List keywords) {
    
    this.keywords = keywords;
    return this;
  }

  public SearchKeywordIdeaServiceSelector addKeywordsItem(String keywordsItem) {
    if (this.keywords == null) {
      this.keywords = new ArrayList<>();
    }
    this.keywords.add(keywordsItem);
    return this;
  }

   /**
   * <div lang=\"ja\"> 検索条件：キーワード<br> ※キーワード提案用<br> ※キーワード、キーワードIDの同時指定はできません。 </div> <div lang=\"en\"> Search condition : Keyword.<br> *Keyword for suggesting.<br> *Can not specify Keyword and Keyword ID at the same time. </div> 
   * @return keywords
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = " 検索条件：キーワード
 ※キーワード提案用
 ※キーワード、キーワードIDの同時指定はできません。 
  Search condition : Keyword.
 *Keyword for suggesting.
 *Can not specify Keyword and Keyword ID at the same time.  ")
  @JsonProperty(JSON_PROPERTY_KEYWORDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getKeywords() {
    return keywords;
  }


  @JsonProperty(JSON_PROPERTY_KEYWORDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setKeywords(List keywords) {
    this.keywords = keywords;
  }


  public SearchKeywordIdeaServiceSelector matchType(SearchKeywordIdeaServiceMatchType matchType) {
    
    this.matchType = matchType;
    return this;
  }

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

  public SearchKeywordIdeaServiceMatchType getMatchType() {
    return matchType;
  }


  @JsonProperty(JSON_PROPERTY_MATCH_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setMatchType(SearchKeywordIdeaServiceMatchType matchType) {
    this.matchType = matchType;
  }


  public SearchKeywordIdeaServiceSelector sortField(SearchKeywordIdeaServiceSortField sortField) {
    
    this.sortField = sortField;
    return this;
  }

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

  public SearchKeywordIdeaServiceSortField getSortField() {
    return sortField;
  }


  @JsonProperty(JSON_PROPERTY_SORT_FIELD)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSortField(SearchKeywordIdeaServiceSortField sortField) {
    this.sortField = sortField;
  }


  public SearchKeywordIdeaServiceSelector sortType(SearchKeywordIdeaServiceSortType sortType) {
    
    this.sortType = sortType;
    return this;
  }

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

  public SearchKeywordIdeaServiceSortType getSortType() {
    return sortType;
  }


  @JsonProperty(JSON_PROPERTY_SORT_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSortType(SearchKeywordIdeaServiceSortType sortType) {
    this.sortType = sortType;
  }


  public SearchKeywordIdeaServiceSelector numberResults(Integer numberResults) {
    
    this.numberResults = numberResults;
    return this;
  }

   /**
   * <div lang=\"ja\">開始位置から取得する結果の数。このフィールドは、1以上を指定する必要があります。</div> <div lang=\"en\">The number of results to retrieve starting from the initial position. This field must be greater than or equal to 1.</div> 
   * minimum: 1
   * maximum: 1000
   * @return numberResults
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "開始位置から取得する結果の数。このフィールドは、1以上を指定する必要があります。
 The number of results to retrieve starting from the initial position. This field must be greater than or equal to 1. ")
  @JsonProperty(JSON_PROPERTY_NUMBER_RESULTS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Integer getNumberResults() {
    return numberResults;
  }


  @JsonProperty(JSON_PROPERTY_NUMBER_RESULTS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setNumberResults(Integer numberResults) {
    this.numberResults = numberResults;
  }


  public SearchKeywordIdeaServiceSelector startIndex(Integer startIndex) {
    
    this.startIndex = startIndex;
    return this;
  }

   /**
   * <div lang=\"ja\">取得を開始する結果セット内の位置。このフィールドは、0以上を指定する必要があります。</div> <div lang=\"en\">The position within the result set where retrieval begins. This field must be greater than or equal to 0.</div> 
   * minimum: 1
   * @return startIndex
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "取得を開始する結果セット内の位置。このフィールドは、0以上を指定する必要があります。
 The position within the result set where retrieval begins. This field must be greater than or equal to 0. ")
  @JsonProperty(JSON_PROPERTY_START_INDEX)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Integer getStartIndex() {
    return startIndex;
  }


  @JsonProperty(JSON_PROPERTY_START_INDEX)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setStartIndex(Integer startIndex) {
    this.startIndex = startIndex;
  }


  public SearchKeywordIdeaServiceSelector availabilityStatus(SearchKeywordIdeaServiceAvailabilityStatus availabilityStatus) {
    
    this.availabilityStatus = availabilityStatus;
    return this;
  }

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

  public SearchKeywordIdeaServiceAvailabilityStatus getAvailabilityStatus() {
    return availabilityStatus;
  }


  @JsonProperty(JSON_PROPERTY_AVAILABILITY_STATUS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setAvailabilityStatus(SearchKeywordIdeaServiceAvailabilityStatus availabilityStatus) {
    this.availabilityStatus = availabilityStatus;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    SearchKeywordIdeaServiceSelector searchKeywordIdeaServiceSelector = (SearchKeywordIdeaServiceSelector) o;
    return Objects.equals(this.keywordFrequency, searchKeywordIdeaServiceSelector.keywordFrequency) &&
        Objects.equals(this.keywordIds, searchKeywordIdeaServiceSelector.keywordIds) &&
        Objects.equals(this.keywordRecency, searchKeywordIdeaServiceSelector.keywordRecency) &&
        Objects.equals(this.keywords, searchKeywordIdeaServiceSelector.keywords) &&
        Objects.equals(this.matchType, searchKeywordIdeaServiceSelector.matchType) &&
        Objects.equals(this.sortField, searchKeywordIdeaServiceSelector.sortField) &&
        Objects.equals(this.sortType, searchKeywordIdeaServiceSelector.sortType) &&
        Objects.equals(this.numberResults, searchKeywordIdeaServiceSelector.numberResults) &&
        Objects.equals(this.startIndex, searchKeywordIdeaServiceSelector.startIndex) &&
        Objects.equals(this.availabilityStatus, searchKeywordIdeaServiceSelector.availabilityStatus);
  }

  @Override
  public int hashCode() {
    return Objects.hash(keywordFrequency, keywordIds, keywordRecency, keywords, matchType, sortField, sortType, numberResults, startIndex, availabilityStatus);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class SearchKeywordIdeaServiceSelector {\n");
    sb.append("    keywordFrequency: ").append(toIndentedString(keywordFrequency)).append("\n");
    sb.append("    keywordIds: ").append(toIndentedString(keywordIds)).append("\n");
    sb.append("    keywordRecency: ").append(toIndentedString(keywordRecency)).append("\n");
    sb.append("    keywords: ").append(toIndentedString(keywords)).append("\n");
    sb.append("    matchType: ").append(toIndentedString(matchType)).append("\n");
    sb.append("    sortField: ").append(toIndentedString(sortField)).append("\n");
    sb.append("    sortType: ").append(toIndentedString(sortType)).append("\n");
    sb.append("    numberResults: ").append(toIndentedString(numberResults)).append("\n");
    sb.append("    startIndex: ").append(toIndentedString(startIndex)).append("\n");
    sb.append("    availabilityStatus: ").append(toIndentedString(availabilityStatus)).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    ");
  }

}