• Home
• com.adobe.target
• target-java-sdk
• 1.0.0
• source code
• PageLoadResponse.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 * Copyright 2019 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.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.*;

/**
 * Page load response. Contains the result of prefetching or executing a request that will retrieve content for all
 * selectors not associated with a particular view.
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public class PageLoadResponse {
    @JsonProperty("options")
    private List options = new ArrayList<>();

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

    @JsonProperty("analytics")
    private AnalyticsResponse analytics = null;

    @JsonProperty("state")
    private String state;

    @JsonProperty("trace")
    private Map trace = new HashMap<>();

    public PageLoadResponse options(List options) {
        this.options = options;
        return this;
    }

    public PageLoadResponse addOptionsItem(Option optionsItem) {
        if (this.options == null) {
            this.options = new ArrayList<>();
        }
        this.options.add(optionsItem);
        return this;
    }

    /**
     * List of options that should be applied. Note: options that have been set on selectors assigned to views will
     * not be included here.
     *
     * @return options
     **/

    public List getOptions() {
        return options;
    }

    public void setOptions(List options) {
        this.options = options;
    }

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

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

    /**
     * Click track metrics. Note that click metrics for selectors set with views will not be included here. In case
     * the same activity is serving content for selectors both assinged to a view and selectors without any views, and
     * having click track metrics that are not assotiated 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 page load response's metrics.   * in case of a
     * request, with both, execute and prefetch, metrics will be set in the page load response's     metrics only.
     *
     * @return metrics
     **/

    public List getMetrics() {
        return metrics;
    }

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

    public PageLoadResponse analytics(AnalyticsResponse analytics) {
        this.analytics = analytics;
        return this;
    }

    /**
     * Get analytics
     *
     * @return analytics
     **/

    public AnalyticsResponse getAnalytics() {
        return analytics;
    }

    public void setAnalytics(AnalyticsResponse analytics) {
        this.analytics = analytics;
    }

    public PageLoadResponse state(String state) {
        this.state = state;
        return this;
    }

    /**
     * View state token that must be sent back with display notification for the view. May only be present for
     * prefetch requests.
     *
     * @return state
     **/

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }

    public PageLoadResponse trace(Map trace) {
        this.trace = trace;
        return this;
    }

    public PageLoadResponse putTraceItem(String key, Object traceItem) {
        if (this.trace == null) {
            this.trace = new HashMap<>();
        }
        this.trace.put(key, traceItem);
        return this;
    }

    /**
     * The object containing all trace data for the request, only present if the trace token was provided in the
     * request.
     *
     * @return trace
     **/

    public Map getTrace() {
        return trace;
    }

    public void setTrace(Map trace) {
        this.trace = trace;
    }


    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        PageLoadResponse pageLoadResponse = (PageLoadResponse) o;
        return Objects.equals(this.options, pageLoadResponse.options) &&
                Objects.equals(this.metrics, pageLoadResponse.metrics) &&
                Objects.equals(this.analytics, pageLoadResponse.analytics) &&
                Objects.equals(this.state, pageLoadResponse.state) &&
                Objects.equals(this.trace, pageLoadResponse.trace);
    }

    @Override
    public int hashCode() {
        return Objects.hash(options, metrics, analytics, state, trace);
    }


    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("class PageLoadResponse {\n");
        sb.append("    options: ").append(toIndentedString(options)).append("\n");
        sb.append("    metrics: ").append(toIndentedString(metrics)).append("\n");
        sb.append("    analytics: ").append(toIndentedString(analytics)).append("\n");
        sb.append("    state: ").append(toIndentedString(state)).append("\n");
        sb.append("    trace: ").append(toIndentedString(trace)).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    ");
    }

}