com.google.api.services.serviceusage.v1.model

Class DocumentationRule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.serviceusage.v1.model.DocumentationRule

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DocumentationRule
extends GenericJson

A documentation rule provides information about individual API elements.

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 Service Usage 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>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DocumentationRule()

Method Summary

Modifier and Type	Method and Description
DocumentationRule	clone()
String	getDeprecationDescription() Deprecation description of the selected element(s).
String	getDescription() The description is the comment in front of the selected proto element, such as a message, a method, a 'service' definition, or a field.
String	getSelector() The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.
DocumentationRule	set(String fieldName, Object value)
DocumentationRule	setDeprecationDescription(String deprecationDescription) Deprecation description of the selected element(s).
DocumentationRule	setDescription(String description) The description is the comment in front of the selected proto element, such as a message, a method, a 'service' definition, or a field.
DocumentationRule	setSelector(String selector) The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value.

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

DocumentationRule

public DocumentationRule()

Method Detail

getDeprecationDescription

public String getDeprecationDescription()

Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.

Returns:

value or null for none

setDeprecationDescription

public DocumentationRule setDeprecationDescription(String deprecationDescription)

Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`.

Parameters:

deprecationDescription - deprecationDescription or null for none

getDescription

public String getDescription()

The description is the comment in front of the selected proto element, such as a message, a method, a 'service' definition, or a field.

Returns:

value or null for none

setDescription

public DocumentationRule setDescription(String description)

The description is the comment in front of the selected proto element, such as a message, a method, a 'service' definition, or a field.

Parameters:

description - description or null for none

getSelector

public String getSelector()

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

Returns:

value or null for none

setSelector

public DocumentationRule setSelector(String selector)

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

Parameters:

selector - selector or null for none

set

public DocumentationRule set(String fieldName,
                             Object value)

Overrides:

set in class GenericJson

clone

public DocumentationRule clone()

Overrides:

clone in class GenericJson