jp.co.yahoo.adssearchapi.v12.model.ReportDefinitionServiceReportFieldAttribute 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 com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;

/**
 * <div lang=\"ja\">ReportDefinitionServiceReportFieldAttributeオブジェクトは、レポート定義の作成に使用できるフィールドを表します。</div> <div lang=\"en\">ReportDefinitionServiceReportFieldAttribute object describes the available field to create report definition.</div> 
 */
@ApiModel(description = "ReportDefinitionServiceReportFieldAttributeオブジェクトは、レポート定義の作成に使用できるフィールドを表します。
 ReportDefinitionServiceReportFieldAttribute object describes the available field to create report definition. ")
@JsonPropertyOrder({
  ReportDefinitionServiceReportFieldAttribute.JSON_PROPERTY_FILTERABLE,
  ReportDefinitionServiceReportFieldAttribute.JSON_PROPERTY_SELECTABLE,
  ReportDefinitionServiceReportFieldAttribute.JSON_PROPERTY_DISPLAY_FIELD_NAME_EN,
  ReportDefinitionServiceReportFieldAttribute.JSON_PROPERTY_DISPLAY_FIELD_NAME_JA,
  ReportDefinitionServiceReportFieldAttribute.JSON_PROPERTY_FIELD_NAME,
  ReportDefinitionServiceReportFieldAttribute.JSON_PROPERTY_FIELD_TYPE,
  ReportDefinitionServiceReportFieldAttribute.JSON_PROPERTY_IMPOSSIBLE_COMBINATION_FIELDS,
  ReportDefinitionServiceReportFieldAttribute.JSON_PROPERTY_XML_ATTRIBUTE_NAME
})
@JsonTypeName("ReportDefinitionServiceReportFieldAttribute")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class ReportDefinitionServiceReportFieldAttribute {
  public static final String JSON_PROPERTY_FILTERABLE = "filterable";
  private Boolean filterable;

  public static final String JSON_PROPERTY_SELECTABLE = "selectable";
  private Boolean selectable;

  public static final String JSON_PROPERTY_DISPLAY_FIELD_NAME_EN = "displayFieldNameEn";
  private String displayFieldNameEn;

  public static final String JSON_PROPERTY_DISPLAY_FIELD_NAME_JA = "displayFieldNameJa";
  private String displayFieldNameJa;

  public static final String JSON_PROPERTY_FIELD_NAME = "fieldName";
  private String fieldName;

  public static final String JSON_PROPERTY_FIELD_TYPE = "fieldType";
  private String fieldType;

  public static final String JSON_PROPERTY_IMPOSSIBLE_COMBINATION_FIELDS = "impossibleCombinationFields";
  private List impossibleCombinationFields = null;

  public static final String JSON_PROPERTY_XML_ATTRIBUTE_NAME = "xmlAttributeName";
  private String xmlAttributeName;

  public ReportDefinitionServiceReportFieldAttribute() { 
  }

  public ReportDefinitionServiceReportFieldAttribute filterable(Boolean filterable) {
    
    this.filterable = filterable;
    return this;
  }

   /**
   * <div lang=\"ja\">ユーザーがこのフィールドにフィルタを 適用できるかどうかを示します。</div> <div lang=\"en\">Indicate if use can filter the fields.</div> 
   * @return filterable
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ユーザーがこのフィールドにフィルタを 適用できるかどうかを示します。
 Indicate if use can filter the fields. ")
  @JsonProperty(JSON_PROPERTY_FILTERABLE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Boolean getFilterable() {
    return filterable;
  }


  @JsonProperty(JSON_PROPERTY_FILTERABLE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setFilterable(Boolean filterable) {
    this.filterable = filterable;
  }


  public ReportDefinitionServiceReportFieldAttribute selectable(Boolean selectable) {
    
    this.selectable = selectable;
    return this;
  }

   /**
   * <div lang=\"ja\">ユーザーがこのフィールドを 選択できるかどうかを示します。</div> <div lang=\"en\">Indicate if user can select the fields.</div> 
   * @return selectable
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ユーザーがこのフィールドを 選択できるかどうかを示します。
 Indicate if user can select the fields. ")
  @JsonProperty(JSON_PROPERTY_SELECTABLE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Boolean getSelectable() {
    return selectable;
  }


  @JsonProperty(JSON_PROPERTY_SELECTABLE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setSelectable(Boolean selectable) {
    this.selectable = selectable;
  }


  public ReportDefinitionServiceReportFieldAttribute displayFieldNameEn(String displayFieldNameEn) {
    
    this.displayFieldNameEn = displayFieldNameEn;
    return this;
  }

   /**
   * <div lang=\"ja\">ダウンロードされたレポートに 表示される英語名です。</div> <div lang=\"en\">Field name displayed in downloaded report (in English).</div> 
   * @return displayFieldNameEn
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ダウンロードされたレポートに 表示される英語名です。
 Field name displayed in downloaded report (in English). ")
  @JsonProperty(JSON_PROPERTY_DISPLAY_FIELD_NAME_EN)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getDisplayFieldNameEn() {
    return displayFieldNameEn;
  }


  @JsonProperty(JSON_PROPERTY_DISPLAY_FIELD_NAME_EN)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDisplayFieldNameEn(String displayFieldNameEn) {
    this.displayFieldNameEn = displayFieldNameEn;
  }


  public ReportDefinitionServiceReportFieldAttribute displayFieldNameJa(String displayFieldNameJa) {
    
    this.displayFieldNameJa = displayFieldNameJa;
    return this;
  }

   /**
   * <div lang=\"ja\">ダウンロードされたレポートに 表示される日本語名です。</div> <div lang=\"en\">Field name displayed in downloaded report (in Japanese).</div> 
   * @return displayFieldNameJa
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ダウンロードされたレポートに 表示される日本語名です。
 Field name displayed in downloaded report (in Japanese). ")
  @JsonProperty(JSON_PROPERTY_DISPLAY_FIELD_NAME_JA)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getDisplayFieldNameJa() {
    return displayFieldNameJa;
  }


  @JsonProperty(JSON_PROPERTY_DISPLAY_FIELD_NAME_JA)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setDisplayFieldNameJa(String displayFieldNameJa) {
    this.displayFieldNameJa = displayFieldNameJa;
  }


  public ReportDefinitionServiceReportFieldAttribute fieldName(String fieldName) {
    
    this.fieldName = fieldName;
    return this;
  }

   /**
   * <div lang=\"ja\">フィールド名です。</div> <div lang=\"en\">Field name.</div> 
   * @return fieldName
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "フィールド名です。
 Field name. ")
  @JsonProperty(JSON_PROPERTY_FIELD_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getFieldName() {
    return fieldName;
  }


  @JsonProperty(JSON_PROPERTY_FIELD_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setFieldName(String fieldName) {
    this.fieldName = fieldName;
  }


  public ReportDefinitionServiceReportFieldAttribute fieldType(String fieldType) {
    
    this.fieldType = fieldType;
    return this;
  }

   /**
   * <div lang=\"ja\">フィールドの種類です。<br> 数字、文字列、Enum値等を表します。</div> <div lang=\"en\">Type of field.<br> Displays int, string, Enum, etc.</div> 
   * @return fieldType
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "フィールドの種類です。
 数字、文字列、Enum値等を表します。
 Type of field.
 Displays int, string, Enum, etc. ")
  @JsonProperty(JSON_PROPERTY_FIELD_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getFieldType() {
    return fieldType;
  }


  @JsonProperty(JSON_PROPERTY_FIELD_TYPE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setFieldType(String fieldType) {
    this.fieldType = fieldType;
  }


  public ReportDefinitionServiceReportFieldAttribute impossibleCombinationFields(List impossibleCombinationFields) {
    
    this.impossibleCombinationFields = impossibleCombinationFields;
    return this;
  }

  public ReportDefinitionServiceReportFieldAttribute addImpossibleCombinationFieldsItem(String impossibleCombinationFieldsItem) {
    if (this.impossibleCombinationFields == null) {
      this.impossibleCombinationFields = new ArrayList<>();
    }
    this.impossibleCombinationFields.add(impossibleCombinationFieldsItem);
    return this;
  }

   /**
   * <div lang=\"ja\">組み合わせができないレポートフィールドです。</div> <div lang=\"en\">Report fields which cannot be combined.</div> 
   * @return impossibleCombinationFields
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "組み合わせができないレポートフィールドです。
 Report fields which cannot be combined. ")
  @JsonProperty(JSON_PROPERTY_IMPOSSIBLE_COMBINATION_FIELDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public List getImpossibleCombinationFields() {
    return impossibleCombinationFields;
  }


  @JsonProperty(JSON_PROPERTY_IMPOSSIBLE_COMBINATION_FIELDS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setImpossibleCombinationFields(List impossibleCombinationFields) {
    this.impossibleCombinationFields = impossibleCombinationFields;
  }


  public ReportDefinitionServiceReportFieldAttribute xmlAttributeName(String xmlAttributeName) {
    
    this.xmlAttributeName = xmlAttributeName;
    return this;
  }

   /**
   * <div lang=\"ja\">ダウンロードしたレポートの XMLアトリビュートです。</div> <div lang=\"en\">XML attribute name displayed in downloaded report.</div> 
   * @return xmlAttributeName
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "ダウンロードしたレポートの XMLアトリビュートです。
 XML attribute name displayed in downloaded report. ")
  @JsonProperty(JSON_PROPERTY_XML_ATTRIBUTE_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getXmlAttributeName() {
    return xmlAttributeName;
  }


  @JsonProperty(JSON_PROPERTY_XML_ATTRIBUTE_NAME)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setXmlAttributeName(String xmlAttributeName) {
    this.xmlAttributeName = xmlAttributeName;
  }


  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ReportDefinitionServiceReportFieldAttribute reportDefinitionServiceReportFieldAttribute = (ReportDefinitionServiceReportFieldAttribute) o;
    return Objects.equals(this.filterable, reportDefinitionServiceReportFieldAttribute.filterable) &&
        Objects.equals(this.selectable, reportDefinitionServiceReportFieldAttribute.selectable) &&
        Objects.equals(this.displayFieldNameEn, reportDefinitionServiceReportFieldAttribute.displayFieldNameEn) &&
        Objects.equals(this.displayFieldNameJa, reportDefinitionServiceReportFieldAttribute.displayFieldNameJa) &&
        Objects.equals(this.fieldName, reportDefinitionServiceReportFieldAttribute.fieldName) &&
        Objects.equals(this.fieldType, reportDefinitionServiceReportFieldAttribute.fieldType) &&
        Objects.equals(this.impossibleCombinationFields, reportDefinitionServiceReportFieldAttribute.impossibleCombinationFields) &&
        Objects.equals(this.xmlAttributeName, reportDefinitionServiceReportFieldAttribute.xmlAttributeName);
  }

  @Override
  public int hashCode() {
    return Objects.hash(filterable, selectable, displayFieldNameEn, displayFieldNameJa, fieldName, fieldType, impossibleCombinationFields, xmlAttributeName);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ReportDefinitionServiceReportFieldAttribute {\n");
    sb.append("    filterable: ").append(toIndentedString(filterable)).append("\n");
    sb.append("    selectable: ").append(toIndentedString(selectable)).append("\n");
    sb.append("    displayFieldNameEn: ").append(toIndentedString(displayFieldNameEn)).append("\n");
    sb.append("    displayFieldNameJa: ").append(toIndentedString(displayFieldNameJa)).append("\n");
    sb.append("    fieldName: ").append(toIndentedString(fieldName)).append("\n");
    sb.append("    fieldType: ").append(toIndentedString(fieldType)).append("\n");
    sb.append("    impossibleCombinationFields: ").append(toIndentedString(impossibleCombinationFields)).append("\n");
    sb.append("    xmlAttributeName: ").append(toIndentedString(xmlAttributeName)).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    ");
  }

}