com.google.api.services.digitalassetlinks.v1.model

Class CheckResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.digitalassetlinks.v1.model.CheckResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Response message for the CheckAssetLinks call.

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 Digital Asset Links 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
CheckResponse()

Method Summary

Modifier and Type	Method and Description
CheckResponse	clone()
String	getDebugString() Human-readable message containing information intended to help end users understand, reproduce and debug the result.
List<String>	getErrorCode() Error codes that describe the result of the Check operation.
Boolean	getLinked() Set to true if the assets specified in the request are linked by the relation specified in the request.
String	getMaxAge() From serving time, how much longer the response should be considered valid barring further updates.
List<Map<String,Object>>	getRelationExtensions() Statements may specify relation level extensions/payloads to express more details when declaring permissions to grant from the source asset to the target asset.
CheckResponse	set(String fieldName, Object value)
CheckResponse	setDebugString(String debugString) Human-readable message containing information intended to help end users understand, reproduce and debug the result.
CheckResponse	setErrorCode(List<String> errorCode) Error codes that describe the result of the Check operation.
CheckResponse	setLinked(Boolean linked) Set to true if the assets specified in the request are linked by the relation specified in the request.
CheckResponse	setMaxAge(String maxAge) From serving time, how much longer the response should be considered valid barring further updates.
CheckResponse	setRelationExtensions(List<Map<String,Object>> relationExtensions) Statements may specify relation level extensions/payloads to express more details when declaring permissions to grant from the source asset to the target asset.

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

CheckResponse

public CheckResponse()

Method Detail

getDebugString

public String getDebugString()

Human-readable message containing information intended to help end users understand, reproduce and debug the result. The message will be in English and we are currently not planning to offer any translations. Please note that no guarantees are made about the contents or format of this string. Any aspect of it may be subject to change without notice. You should not attempt to programmatically parse this data. For programmatic access, use the error_code field below.

Returns:

value or null for none

setDebugString

public CheckResponse setDebugString(String debugString)

Human-readable message containing information intended to help end users understand, reproduce and debug the result. The message will be in English and we are currently not planning to offer any translations. Please note that no guarantees are made about the contents or format of this string. Any aspect of it may be subject to change without notice. You should not attempt to programmatically parse this data. For programmatic access, use the error_code field below.

Parameters:

debugString - debugString or null for none

getErrorCode

public List<String> getErrorCode()

Error codes that describe the result of the Check operation. NOTE: Error codes may be populated even when `linked` is true. The error codes do not necessarily imply that the request failed, but rather, specify any errors encountered in the statements file(s) which may or may not impact whether the server determines the requested source and target to be linked.

Returns:

value or null for none

setErrorCode

public CheckResponse setErrorCode(List<String> errorCode)

Error codes that describe the result of the Check operation. NOTE: Error codes may be populated even when `linked` is true. The error codes do not necessarily imply that the request failed, but rather, specify any errors encountered in the statements file(s) which may or may not impact whether the server determines the requested source and target to be linked.

Parameters:

errorCode - errorCode or null for none

getLinked

public Boolean getLinked()

Set to true if the assets specified in the request are linked by the relation specified in the request.

Returns:

value or null for none

setLinked

public CheckResponse setLinked(Boolean linked)

Set to true if the assets specified in the request are linked by the relation specified in the request.

Parameters:

linked - linked or null for none

getMaxAge

public String getMaxAge()

From serving time, how much longer the response should be considered valid barring further updates. REQUIRED

Returns:

value or null for none

setMaxAge

public CheckResponse setMaxAge(String maxAge)

From serving time, how much longer the response should be considered valid barring further updates. REQUIRED

Parameters:

maxAge - maxAge or null for none

getRelationExtensions

public List<Map<String,Object>> getRelationExtensions()

Statements may specify relation level extensions/payloads to express more details when declaring permissions to grant from the source asset to the target asset. When requested, the API will return relation_extensions specified in any and all statements linking the requested source and target assets by the relation specified in the request.

Returns:

value or null for none

setRelationExtensions

public CheckResponse setRelationExtensions(List<Map<String,Object>> relationExtensions)

Statements may specify relation level extensions/payloads to express more details when declaring permissions to grant from the source asset to the target asset. When requested, the API will return relation_extensions specified in any and all statements linking the requested source and target assets by the relation specified in the request.

Parameters:

relationExtensions - relationExtensions or null for none

set

public CheckResponse set(String fieldName,
                         Object value)

Overrides:

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

clone

public CheckResponse clone()

Overrides:

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