com.google.api.services.dataflow.model

Class ParameterMetadata

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dataflow.model.ParameterMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ParameterMetadata
extends GenericJson

Metadata for a specific parameter.

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 Dataflow 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
ParameterMetadata()

Method Summary

Modifier and Type	Method and Description
ParameterMetadata	clone()
String	getHelpText() Required.
Boolean	getIsOptional() Optional.
String	getLabel() Required.
String	getName() Required.
String	getParamType() Optional.
List<String>	getRegexes() Optional.
ParameterMetadata	set(String fieldName, Object value)
ParameterMetadata	setHelpText(String helpText) Required.
ParameterMetadata	setIsOptional(Boolean isOptional) Optional.
ParameterMetadata	setLabel(String label) Required.
ParameterMetadata	setName(String name) Required.
ParameterMetadata	setParamType(String paramType) Optional.
ParameterMetadata	setRegexes(List<String> regexes) Optional.

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

ParameterMetadata

public ParameterMetadata()

Method Detail

getHelpText

public String getHelpText()

Required. The help text to display for the parameter.

Returns:

value or null for none

setHelpText

public ParameterMetadata setHelpText(String helpText)

Required. The help text to display for the parameter.

Parameters:

helpText - helpText or null for none

getIsOptional

public Boolean getIsOptional()

Optional. Whether the parameter is optional. Defaults to false.

Returns:

value or null for none

setIsOptional

public ParameterMetadata setIsOptional(Boolean isOptional)

Optional. Whether the parameter is optional. Defaults to false.

Parameters:

isOptional - isOptional or null for none

getLabel

public String getLabel()

Required. The label to display for the parameter.

Returns:

value or null for none

setLabel

public ParameterMetadata setLabel(String label)

Required. The label to display for the parameter.

Parameters:

label - label or null for none

getName

public String getName()

Required. The name of the parameter.

Returns:

value or null for none

setName

public ParameterMetadata setName(String name)

Required. The name of the parameter.

Parameters:

name - name or null for none

getParamType

public String getParamType()

Optional. The type of the parameter. Used for selecting input picker.

Returns:

value or null for none

setParamType

public ParameterMetadata setParamType(String paramType)

Optional. The type of the parameter. Used for selecting input picker.

Parameters:

paramType - paramType or null for none

getRegexes

public List<String> getRegexes()

Optional. Regexes that the parameter must match.

Returns:

value or null for none

setRegexes

public ParameterMetadata setRegexes(List<String> regexes)

Optional. Regexes that the parameter must match.

Parameters:

regexes - regexes or null for none

set

public ParameterMetadata set(String fieldName,
                             Object value)

Overrides:

set in class GenericJson

clone

public ParameterMetadata clone()

Overrides:

clone in class GenericJson