Class ConfigVariableTemplate (0.28.0)

public final class ConfigVariableTemplate extends GeneratedMessageV3 implements ConfigVariableTemplateOrBuilder

ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.

Protobuf type google.cloud.apihub.v1.ConfigVariableTemplate

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENUM_OPTIONS_FIELD_NUMBER

public static final int ENUM_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

MULTI_SELECT_OPTIONS_FIELD_NUMBER

public static final int MULTI_SELECT_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

REQUIRED_FIELD_NUMBER

public static final int REQUIRED_FIELD_NUMBER
Field Value
Type Description
int

VALIDATION_REGEX_FIELD_NUMBER

public static final int VALIDATION_REGEX_FIELD_NUMBER
Field Value
Type Description
int

VALUE_TYPE_FIELD_NUMBER

public static final int VALUE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConfigVariableTemplate getDefaultInstance()
Returns
Type Description
ConfigVariableTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ConfigVariableTemplate.Builder newBuilder()
Returns
Type Description
ConfigVariableTemplate.Builder

newBuilder(ConfigVariableTemplate prototype)

public static ConfigVariableTemplate.Builder newBuilder(ConfigVariableTemplate prototype)
Parameter
Name Description
prototype ConfigVariableTemplate
Returns
Type Description
ConfigVariableTemplate.Builder

parseDelimitedFrom(InputStream input)

public static ConfigVariableTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConfigVariableTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConfigVariableTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConfigVariableTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConfigVariableTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConfigVariableTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConfigVariableTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConfigVariableTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConfigVariableTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConfigVariableTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConfigVariableTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConfigVariableTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConfigVariableTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConfigVariableTemplate> parser()
Returns
Type Description
Parser<ConfigVariableTemplate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ConfigVariableTemplate getDefaultInstanceForType()
Returns
Type Description
ConfigVariableTemplate

getDescription()

public String getDescription()

Optional. Description.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getEnumOptions(int index)

public ConfigValueOption getEnumOptions(int index)

Optional. Enum options. To be populated if ValueType is ENUM.

repeated .google.cloud.apihub.v1.ConfigValueOption enum_options = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ConfigValueOption

getEnumOptionsCount()

public int getEnumOptionsCount()

Optional. Enum options. To be populated if ValueType is ENUM.

repeated .google.cloud.apihub.v1.ConfigValueOption enum_options = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getEnumOptionsList()

public List<ConfigValueOption> getEnumOptionsList()

Optional. Enum options. To be populated if ValueType is ENUM.

repeated .google.cloud.apihub.v1.ConfigValueOption enum_options = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ConfigValueOption>

getEnumOptionsOrBuilder(int index)

public ConfigValueOptionOrBuilder getEnumOptionsOrBuilder(int index)

Optional. Enum options. To be populated if ValueType is ENUM.

repeated .google.cloud.apihub.v1.ConfigValueOption enum_options = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ConfigValueOptionOrBuilder

getEnumOptionsOrBuilderList()

public List<? extends ConfigValueOptionOrBuilder> getEnumOptionsOrBuilderList()

Optional. Enum options. To be populated if ValueType is ENUM.

repeated .google.cloud.apihub.v1.ConfigValueOption enum_options = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.apihub.v1.ConfigValueOptionOrBuilder>

getId()

public String getId()

Required. ID of the config variable. Must be unique within the configuration.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Required. ID of the config variable. Must be unique within the configuration.

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for id.

getMultiSelectOptions(int index)

public ConfigValueOption getMultiSelectOptions(int index)

Optional. Multi select options. To be populated if ValueType is MULTI_SELECT.

repeated .google.cloud.apihub.v1.ConfigValueOption multi_select_options = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ConfigValueOption

getMultiSelectOptionsCount()

public int getMultiSelectOptionsCount()

Optional. Multi select options. To be populated if ValueType is MULTI_SELECT.

repeated .google.cloud.apihub.v1.ConfigValueOption multi_select_options = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getMultiSelectOptionsList()

public List<ConfigValueOption> getMultiSelectOptionsList()

Optional. Multi select options. To be populated if ValueType is MULTI_SELECT.

repeated .google.cloud.apihub.v1.ConfigValueOption multi_select_options = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ConfigValueOption>

getMultiSelectOptionsOrBuilder(int index)

public ConfigValueOptionOrBuilder getMultiSelectOptionsOrBuilder(int index)

Optional. Multi select options. To be populated if ValueType is MULTI_SELECT.

repeated .google.cloud.apihub.v1.ConfigValueOption multi_select_options = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ConfigValueOptionOrBuilder

getMultiSelectOptionsOrBuilderList()

public List<? extends ConfigValueOptionOrBuilder> getMultiSelectOptionsOrBuilderList()

Optional. Multi select options. To be populated if ValueType is MULTI_SELECT.

repeated .google.cloud.apihub.v1.ConfigValueOption multi_select_options = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.apihub.v1.ConfigValueOptionOrBuilder>

getParserForType()

public Parser<ConfigVariableTemplate> getParserForType()
Returns
Type Description
Parser<ConfigVariableTemplate>
Overrides

getRequired()

public boolean getRequired()

Optional. Flag represents that this ConfigVariable must be provided for a PluginInstance.

bool required = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The required.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValidationRegex()

public String getValidationRegex()

Optional. Regular expression in RE2 syntax used for validating the value of a ConfigVariable.

string validation_regex = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The validationRegex.

getValidationRegexBytes()

public ByteString getValidationRegexBytes()

Optional. Regular expression in RE2 syntax used for validating the value of a ConfigVariable.

string validation_regex = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for validationRegex.

getValueType()

public ConfigVariableTemplate.ValueType getValueType()

Required. Type of the parameter: string, int, bool etc.

.google.cloud.apihub.v1.ConfigVariableTemplate.ValueType value_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ConfigVariableTemplate.ValueType

The valueType.

getValueTypeValue()

public int getValueTypeValue()

Required. Type of the parameter: string, int, bool etc.

.google.cloud.apihub.v1.ConfigVariableTemplate.ValueType value_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for valueType.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConfigVariableTemplate.Builder newBuilderForType()
Returns
Type Description
ConfigVariableTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConfigVariableTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConfigVariableTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ConfigVariableTemplate.Builder toBuilder()
Returns
Type Description
ConfigVariableTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException