• Home
• com.google.apis
• google-api-services-dataflow
• v1b3-rev20231112-2.0.0
• source code
• ParameterMetadata.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.dataflow.model.ParameterMetadata.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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 com.google.api.client.json.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
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


ParameterMetadata() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


ParameterMetadata
clone() 


Map<String,String>
getCustomMetadata()
Optional.



String
getDefaultValue()
Optional.



List<ParameterMetadataEnumOption>
getEnumOptions()
Optional.



String
getGroupName()
Optional.



String
getHelpText()
Required.



Boolean
getIsOptional()
Optional.



String
getLabel()
Required.



String
getName()
Required.



String
getParamType()
Optional.



String
getParentName()
Optional.



List<String>
getParentTriggerValues()
Optional.



List<String>
getRegexes()
Optional.



ParameterMetadata
set(String fieldName,
   Object value) 


ParameterMetadata
setCustomMetadata(Map<String,String> customMetadata)
Optional.



ParameterMetadata
setDefaultValue(String defaultValue)
Optional.



ParameterMetadata
setEnumOptions(List<ParameterMetadataEnumOption> enumOptions)
Optional.



ParameterMetadata
setGroupName(String groupName)
Optional.



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
setParentName(String parentName)
Optional.



ParameterMetadata
setParentTriggerValues(List<String> parentTriggerValues)
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





getCustomMetadata
public Map<String,String> getCustomMetadata()
Optional. Additional metadata for describing this parameter.

Returns:
value or null for none








setCustomMetadata
public ParameterMetadata setCustomMetadata(Map<String,String> customMetadata)
Optional. Additional metadata for describing this parameter.

Parameters:
customMetadata - customMetadata or null for none








getDefaultValue
public String getDefaultValue()
Optional. The default values will pre-populate the parameter with the given value from the
 proto. If default_value is left empty, the parameter will be populated with a default of the
 relevant type, e.g. false for a boolean.

Returns:
value or null for none








setDefaultValue
public ParameterMetadata setDefaultValue(String defaultValue)
Optional. The default values will pre-populate the parameter with the given value from the
 proto. If default_value is left empty, the parameter will be populated with a default of the
 relevant type, e.g. false for a boolean.

Parameters:
defaultValue - defaultValue or null for none








getEnumOptions
public List<ParameterMetadataEnumOption> getEnumOptions()
Optional. The options shown when ENUM ParameterType is specified.

Returns:
value or null for none








setEnumOptions
public ParameterMetadata setEnumOptions(List<ParameterMetadataEnumOption> enumOptions)
Optional. The options shown when ENUM ParameterType is specified.

Parameters:
enumOptions - enumOptions or null for none








getGroupName
public String getGroupName()
Optional. Specifies a group name for this parameter to be rendered under. Group header text
 will be rendered exactly as specified in this field. Only considered when parent_name is NOT
 provided.

Returns:
value or null for none








setGroupName
public ParameterMetadata setGroupName(String groupName)
Optional. Specifies a group name for this parameter to be rendered under. Group header text
 will be rendered exactly as specified in this field. Only considered when parent_name is NOT
 provided.

Parameters:
groupName - groupName or null for none








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








getParentName
public String getParentName()
Optional. Specifies the name of the parent parameter. Used in conjunction with
 'parent_trigger_values' to make this parameter conditional (will only be rendered
 conditionally). Should be mappable to a ParameterMetadata.name field.

Returns:
value or null for none








setParentName
public ParameterMetadata setParentName(String parentName)
Optional. Specifies the name of the parent parameter. Used in conjunction with
 'parent_trigger_values' to make this parameter conditional (will only be rendered
 conditionally). Should be mappable to a ParameterMetadata.name field.

Parameters:
parentName - parentName or null for none








getParentTriggerValues
public List<String> getParentTriggerValues()
Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be
 shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be
 shown. Only considered when this parameter is conditional (when 'parent_name' has been
 provided).

Returns:
value or null for none








setParentTriggerValues
public ParameterMetadata setParentTriggerValues(List<String> parentTriggerValues)
Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be
 shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be
 shown. Only considered when this parameter is conditional (when 'parent_name' has been
 provided).

Parameters:
parentTriggerValues - parentTriggerValues 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 com.google.api.client.json.GenericJson








clone
public ParameterMetadata clone()

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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.