target.apidocs.com.google.api.services.analytics.model.Segments.html Maven / Gradle / Ivy
Segments (Google Analytics API v3-rev20190604-1.30.1)
com.google.api.services.analytics.model
Class Segments
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.analytics.model.Segments
-
public final class Segments
extends GenericJson
An segment collection lists Analytics segments that the user has access to. Each resource in the
collection corresponds to a single Analytics segment.
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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Segments()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Segments
clone()
List<Segment>
getItems()
A list of segments.
Integer
getItemsPerPage()
The maximum number of resources the response can contain, regardless of the actual number of
resources returned.
String
getKind()
Collection type for segments.
String
getNextLink()
Link to next page for this segment collection.
String
getPreviousLink()
Link to previous page for this segment collection.
Integer
getStartIndex()
The starting index of the resources, which is 1 by default or otherwise specified by the start-
index query parameter.
Integer
getTotalResults()
The total number of results for the query, regardless of the number of results in the response.
String
getUsername()
Email ID of the authenticated user
Segments
set(String fieldName,
Object value)
Segments
setItems(List<Segment> items)
A list of segments.
Segments
setItemsPerPage(Integer itemsPerPage)
The maximum number of resources the response can contain, regardless of the actual number of
resources returned.
Segments
setKind(String kind)
Collection type for segments.
Segments
setNextLink(String nextLink)
Link to next page for this segment collection.
Segments
setPreviousLink(String previousLink)
Link to previous page for this segment collection.
Segments
setStartIndex(Integer startIndex)
The starting index of the resources, which is 1 by default or otherwise specified by the start-
index query parameter.
Segments
setTotalResults(Integer totalResults)
The total number of results for the query, regardless of the number of results in the response.
Segments
setUsername(String username)
Email ID of the authenticated user
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
setItems
public Segments setItems(List<Segment> items)
A list of segments.
- Parameters:
items
- items or null
for none
-
getItemsPerPage
public Integer getItemsPerPage()
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.
- Returns:
- value or
null
for none
-
setItemsPerPage
public Segments setItemsPerPage(Integer 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.
- Parameters:
itemsPerPage
- itemsPerPage or null
for none
-
getKind
public String getKind()
Collection type for segments.
- Returns:
- value or
null
for none
-
setKind
public Segments setKind(String kind)
Collection type for segments.
- Parameters:
kind
- kind or null
for none
-
getNextLink
public String getNextLink()
Link to next page for this segment collection.
- Returns:
- value or
null
for none
-
setNextLink
public Segments setNextLink(String nextLink)
Link to next page for this segment collection.
- Parameters:
nextLink
- nextLink or null
for none
-
getPreviousLink
public String getPreviousLink()
Link to previous page for this segment collection.
- Returns:
- value or
null
for none
-
setPreviousLink
public Segments setPreviousLink(String previousLink)
Link to previous page for this segment collection.
- Parameters:
previousLink
- previousLink or null
for none
-
getStartIndex
public Integer getStartIndex()
The starting index of the resources, which is 1 by default or otherwise specified by the start-
index query parameter.
- Returns:
- value or
null
for none
-
setStartIndex
public Segments setStartIndex(Integer startIndex)
The starting index of the resources, which is 1 by default or otherwise specified by the start-
index query parameter.
- Parameters:
startIndex
- startIndex or null
for none
-
getTotalResults
public Integer getTotalResults()
The total number of results for the query, regardless of the number of results in the response.
- Returns:
- value or
null
for none
-
setTotalResults
public Segments setTotalResults(Integer totalResults)
The total number of results for the query, regardless of the number of results in the response.
- Parameters:
totalResults
- totalResults or null
for none
-
getUsername
public String getUsername()
Email ID of the authenticated user
- Returns:
- value or
null
for none
-
setUsername
public Segments setUsername(String username)
Email ID of the authenticated user
- Parameters:
username
- username or null
for none
-
set
public Segments set(String fieldName,
Object value)
- Overrides:
set
in class GenericJson
-
clone
public Segments clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2019 Google. All rights reserved.