com.adobe.target.delivery.v1.model.PrefetchResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of target-java-sdk Show documentation
Adobe Target Java SDK
There is a newer version: 2.6.1
/*
 * Copyright 2021 Adobe. All rights reserved.
 * This file is licensed to you 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 REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 *
 * NOTE: This is an auto generated file. Do not edit directly.
 */
package com.adobe.target.delivery.v1.model;

import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * The object that will return the prefetched content based on the request, active activities etc
 */
public class PrefetchResponse {
  @JsonProperty("views")
  private List views = new ArrayList<>();

  @JsonProperty("pageLoad")
  private PageLoadResponse pageLoad;

  @JsonProperty("mboxes")
  private List mboxes = new ArrayList<>();

  @JsonProperty("metrics")
  private List metrics = new ArrayList<>();

  public PrefetchResponse views(List views) {
    this.views = views;
    return this;
  }

  public PrefetchResponse addViewsItem(View viewsItem) {
    if (this.views == null) {
      this.views = new ArrayList<>();
    }
    this.views.add(viewsItem);
    return this;
  }

  /**
   * Contains all the views matching the request.
   *
   * @return views
   */
  public List getViews() {
    return views;
  }

  public void setViews(List views) {
    this.views = views;
  }

  public PrefetchResponse pageLoad(PageLoadResponse pageLoad) {
    this.pageLoad = pageLoad;
    return this;
  }

  /**
   * Get pageLoad
   *
   * @return pageLoad
   */
  public PageLoadResponse getPageLoad() {
    return pageLoad;
  }

  public void setPageLoad(PageLoadResponse pageLoad) {
    this.pageLoad = pageLoad;
  }

  public PrefetchResponse mboxes(List mboxes) {
    this.mboxes = mboxes;
    return this;
  }

  public PrefetchResponse addMboxesItem(PrefetchMboxResponse mboxesItem) {
    if (this.mboxes == null) {
      this.mboxes = new ArrayList<>();
    }
    this.mboxes.add(mboxesItem);
    return this;
  }

  /**
   * Prefetched mboxes, including content and notification tokens to be sent back when the mboxes
   * are displayed.
   *
   * @return mboxes
   */
  public List getMboxes() {
    return mboxes;
  }

  public void setMboxes(List mboxes) {
    this.mboxes = mboxes;
  }

  public PrefetchResponse metrics(List metrics) {
    this.metrics = metrics;
    return this;
  }

  public PrefetchResponse addMetricsItem(Metric metricsItem) {
    if (this.metrics == null) {
      this.metrics = new ArrayList<>();
    }
    this.metrics.add(metricsItem);
    return this;
  }

  /**
   * Click track metrics that are not assigned with a view but are present in activities that have
   * views. If the same activity is serving content for selectors on a view and selectors
   * unassociated with views, and having click track metrics not associated with any view within the
   * activity, then: * in case of a prefetch-only request, these metrics (tokens) will be set in the
   * prefetch response's metrics. * in case of an execute-only request, the metrics will be set
   * in the pageLoad response's metrics. * in case of a request, with both execute and prefetch,
   * the metrics will be set in the pageLoad response's metrics only.
   *
   * @return metrics
   */
  public List getMetrics() {
    return metrics;
  }

  public void setMetrics(List metrics) {
    this.metrics = metrics;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    PrefetchResponse prefetchResponse = (PrefetchResponse) o;
    return Objects.equals(this.views, prefetchResponse.views)
        && Objects.equals(this.pageLoad, prefetchResponse.pageLoad)
        && Objects.equals(this.mboxes, prefetchResponse.mboxes)
        && Objects.equals(this.metrics, prefetchResponse.metrics);
  }

  @Override
  public int hashCode() {
    return Objects.hash(views, pageLoad, mboxes, metrics);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class PrefetchResponse {\n");
    sb.append("    views: ").append(toIndentedString(views)).append("\n");
    sb.append("    pageLoad: ").append(toIndentedString(pageLoad)).append("\n");
    sb.append("    mboxes: ").append(toIndentedString(mboxes)).append("\n");
    sb.append("    metrics: ").append(toIndentedString(metrics)).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    ");
  }
}