com.google.api.control.model

Enum KnownLabels

java.lang.Object

java.lang.Enum<KnownLabels>

com.google.api.control.model.KnownLabels

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KnownLabels>

public enum KnownLabels
extends java.lang.Enum<KnownLabels>

KnownLabels enumerates the well-known labels and allows them to be added to the ReportRequest's labels.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KnownLabels.Update Update defines a function that allows a ReportRequestInfo to be used to update labels to be added to a ReportRequest

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREDENTIAL_ID
END_USER
END_USER_COUNTRY
ERROR_TYPE
GAE_CLONE_ID
GAE_MODULE_ID
GAE_REPLICA_INDEX
GAE_VERSION_ID
GCP_LOCATION
GCP_PROJECT
GCP_REGION
GCP_RESOURCE_ID
GCP_RESOURCE_TYPE
GCP_SERVICE
GCP_UID
GCP_ZONE
PROTOCOL
REFERER
RESPONSE_CODE
RESPONSE_CODE_CLASS
SCC_PLATFORM
SCC_REFERER
SCC_SERVICE_AGENT
SCC_USER_AGENT
STATUS_CODE
SVC_API_METHOD
SVC_API_VERSION

Field Summary

Fields

Modifier and Type	Field and Description
static KnownLabels.Update	NO_UPDATE A null implementation of KnownLabels.Update
static java.lang.String	SERVICE_AGENT The service agent to record in report requests
static java.lang.String	USER_AGENT The user agent to record in report requests At the moment (2016/08/02), the user agent must be either 'ESP' or 'ESF'

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
com.google.api.LabelDescriptor.ValueType	getType()
KnownLabels.Update	getUpdater()
static boolean	isSupported(com.google.api.LabelDescriptor d) Determines if the given label descriptor is supported
boolean	matches(com.google.api.LabelDescriptor d) Determines if d matches this KnownLabel instance.
void	performUpdate(ReportRequestInfo info, java.util.Map<java.lang.String,java.lang.String> labels) Updates labels with request data
static KnownLabels	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KnownLabels[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CREDENTIAL_ID

public static final KnownLabels CREDENTIAL_ID

END_USER

public static final KnownLabels END_USER

END_USER_COUNTRY

public static final KnownLabels END_USER_COUNTRY

ERROR_TYPE

public static final KnownLabels ERROR_TYPE

PROTOCOL

public static final KnownLabels PROTOCOL

REFERER

public static final KnownLabels REFERER

RESPONSE_CODE

public static final KnownLabels RESPONSE_CODE

RESPONSE_CODE_CLASS

public static final KnownLabels RESPONSE_CODE_CLASS

STATUS_CODE

public static final KnownLabels STATUS_CODE

GAE_CLONE_ID

public static final KnownLabels GAE_CLONE_ID

GAE_MODULE_ID

public static final KnownLabels GAE_MODULE_ID

GAE_REPLICA_INDEX

public static final KnownLabels GAE_REPLICA_INDEX

GAE_VERSION_ID

public static final KnownLabels GAE_VERSION_ID

GCP_LOCATION

public static final KnownLabels GCP_LOCATION

GCP_PROJECT

public static final KnownLabels GCP_PROJECT

GCP_REGION

public static final KnownLabels GCP_REGION

GCP_RESOURCE_ID

public static final KnownLabels GCP_RESOURCE_ID

GCP_RESOURCE_TYPE

public static final KnownLabels GCP_RESOURCE_TYPE

GCP_SERVICE

public static final KnownLabels GCP_SERVICE

GCP_ZONE

public static final KnownLabels GCP_ZONE

GCP_UID

public static final KnownLabels GCP_UID

SVC_API_METHOD

public static final KnownLabels SVC_API_METHOD

SVC_API_VERSION

public static final KnownLabels SVC_API_VERSION

SCC_PLATFORM

public static final KnownLabels SCC_PLATFORM

SCC_REFERER

public static final KnownLabels SCC_REFERER

SCC_SERVICE_AGENT

public static final KnownLabels SCC_SERVICE_AGENT

SCC_USER_AGENT

public static final KnownLabels SCC_USER_AGENT

Field Detail

NO_UPDATE

public static final KnownLabels.Update NO_UPDATE

A null implementation of KnownLabels.Update

USER_AGENT

public static final java.lang.String USER_AGENT

The user agent to record in report requests At the moment (2016/08/02), the user agent must be either 'ESP' or 'ESF'

See Also:

Constant Field Values

SERVICE_AGENT

public static final java.lang.String SERVICE_AGENT

The service agent to record in report requests

Method Detail

values

public static KnownLabels[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KnownLabels c : KnownLabels.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KnownLabels valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

getType

public com.google.api.LabelDescriptor.ValueType getType()

getUpdater

public KnownLabels.Update getUpdater()

matches

public boolean matches(com.google.api.LabelDescriptor d)

Determines if d matches this KnownLabel instance.

Parameters:

d - a LabelDescriptor

Returns:

true if d matches

performUpdate

public void performUpdate(ReportRequestInfo info,
                          java.util.Map<java.lang.String,java.lang.String> labels)

Updates labels with request data

Parameters:

info - contains request data to be reported

labels - the labels to be updated with request data

isSupported

public static boolean isSupported(com.google.api.LabelDescriptor d)

Determines if the given label descriptor is supported

Parameters:

d - a LabelDescriptor

Returns:

true if the label descriptor is supported, otherwise false