com.google.api.services.apigee.v1.model

Class GoogleRpcPreconditionFailureViolation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.apigee.v1.model.GoogleRpcPreconditionFailureViolation

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleRpcPreconditionFailureViolation
extends com.google.api.client.json.GenericJson

A message type used to describe a single precondition failure.

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 Apigee 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

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleRpcPreconditionFailureViolation()

Method Summary

Modifier and Type	Method and Description
GoogleRpcPreconditionFailureViolation	clone()
String	getDescription() A description of how the precondition failed.
String	getSubject() The subject, relative to the type, that failed.
String	getType() The type of PreconditionFailure.
GoogleRpcPreconditionFailureViolation	set(String fieldName, Object value)
GoogleRpcPreconditionFailureViolation	setDescription(String description) A description of how the precondition failed.
GoogleRpcPreconditionFailureViolation	setSubject(String subject) The subject, relative to the type, that failed.
GoogleRpcPreconditionFailureViolation	setType(String type) The type of PreconditionFailure.

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

Constructor Detail

GoogleRpcPreconditionFailureViolation

public GoogleRpcPreconditionFailureViolation()

Method Detail

getDescription

public String getDescription()

A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted".

Returns:

value or null for none

setDescription

public GoogleRpcPreconditionFailureViolation setDescription(String description)

A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: "Terms of service not accepted".

Parameters:

description - description or null for none

getSubject

public String getSubject()

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

Returns:

value or null for none

setSubject

public GoogleRpcPreconditionFailureViolation setSubject(String subject)

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

Parameters:

subject - subject or null for none

getType

public String getType()

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

Returns:

value or null for none

setType

public GoogleRpcPreconditionFailureViolation setType(String type)

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

Parameters:

type - type or null for none

set

public GoogleRpcPreconditionFailureViolation set(String fieldName,
                                                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleRpcPreconditionFailureViolation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson