com.google.api.services.analytics.model.CustomMetrics Maven / Gradle / Ivy
/*
* Licensed 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 CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.analytics.model;
/**
* A custom metric collection lists Analytics custom metrics to which the user has access. Each
* resource in the collection corresponds to a single Analytics custom metric.
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Google Analytics API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class CustomMetrics extends com.google.api.client.json.GenericJson {
/**
* Collection of custom metrics.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List items;
static {
// hack to force ProGuard to consider CustomMetric used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(CustomMetric.class);
}
/**
* The maximum number of resources the response can contain, regardless of the actual number of
* resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or
* otherwise specified by the max-results query parameter.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer itemsPerPage;
/**
* Collection type.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kind;
/**
* Link to next page for this custom metric collection.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String nextLink;
/**
* Link to previous page for this custom metric collection.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String previousLink;
/**
* The starting index of the resources, which is 1 by default or otherwise specified by the start-
* index query parameter.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer startIndex;
/**
* The total number of results for the query, regardless of the number of results in the response.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer totalResults;
/**
* Email ID of the authenticated user
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String username;
/**
* Collection of custom metrics.
* @return value or {@code null} for none
*/
public java.util.List getItems() {
return items;
}
/**
* Collection of custom metrics.
* @param items items or {@code null} for none
*/
public CustomMetrics setItems(java.util.List items) {
this.items = items;
return this;
}
/**
* The maximum number of resources the response can contain, regardless of the actual number of
* resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or
* otherwise specified by the max-results query parameter.
* @return value or {@code null} for none
*/
public java.lang.Integer getItemsPerPage() {
return itemsPerPage;
}
/**
* The maximum number of resources the response can contain, regardless of the actual number of
* resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or
* otherwise specified by the max-results query parameter.
* @param itemsPerPage itemsPerPage or {@code null} for none
*/
public CustomMetrics setItemsPerPage(java.lang.Integer itemsPerPage) {
this.itemsPerPage = itemsPerPage;
return this;
}
/**
* Collection type.
* @return value or {@code null} for none
*/
public java.lang.String getKind() {
return kind;
}
/**
* Collection type.
* @param kind kind or {@code null} for none
*/
public CustomMetrics setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* Link to next page for this custom metric collection.
* @return value or {@code null} for none
*/
public java.lang.String getNextLink() {
return nextLink;
}
/**
* Link to next page for this custom metric collection.
* @param nextLink nextLink or {@code null} for none
*/
public CustomMetrics setNextLink(java.lang.String nextLink) {
this.nextLink = nextLink;
return this;
}
/**
* Link to previous page for this custom metric collection.
* @return value or {@code null} for none
*/
public java.lang.String getPreviousLink() {
return previousLink;
}
/**
* Link to previous page for this custom metric collection.
* @param previousLink previousLink or {@code null} for none
*/
public CustomMetrics setPreviousLink(java.lang.String previousLink) {
this.previousLink = previousLink;
return this;
}
/**
* The starting index of the resources, which is 1 by default or otherwise specified by the start-
* index query parameter.
* @return value or {@code null} for none
*/
public java.lang.Integer getStartIndex() {
return startIndex;
}
/**
* The starting index of the resources, which is 1 by default or otherwise specified by the start-
* index query parameter.
* @param startIndex startIndex or {@code null} for none
*/
public CustomMetrics setStartIndex(java.lang.Integer startIndex) {
this.startIndex = startIndex;
return this;
}
/**
* The total number of results for the query, regardless of the number of results in the response.
* @return value or {@code null} for none
*/
public java.lang.Integer getTotalResults() {
return totalResults;
}
/**
* The total number of results for the query, regardless of the number of results in the response.
* @param totalResults totalResults or {@code null} for none
*/
public CustomMetrics setTotalResults(java.lang.Integer totalResults) {
this.totalResults = totalResults;
return this;
}
/**
* Email ID of the authenticated user
* @return value or {@code null} for none
*/
public java.lang.String getUsername() {
return username;
}
/**
* Email ID of the authenticated user
* @param username username or {@code null} for none
*/
public CustomMetrics setUsername(java.lang.String username) {
this.username = username;
return this;
}
@Override
public CustomMetrics set(String fieldName, Object value) {
return (CustomMetrics) super.set(fieldName, value);
}
@Override
public CustomMetrics clone() {
return (CustomMetrics) super.clone();
}
}