Class ParameterSpec (0.1.0)

public final class ParameterSpec extends GeneratedMessageV3 implements ParameterSpecOrBuilder

A parameter spec of the cloud control.

Protobuf type google.cloud.cloudsecuritycompliance.v1.ParameterSpec

Static Fields

DEFAULT_VALUE_FIELD_NUMBER

public static final int DEFAULT_VALUE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

IS_REQUIRED_FIELD_NUMBER

public static final int IS_REQUIRED_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SUBSTITUTION_RULES_FIELD_NUMBER

public static final int SUBSTITUTION_RULES_FIELD_NUMBER
Field Value
Type Description
int

SUB_PARAMETERS_FIELD_NUMBER

public static final int SUB_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

VALIDATION_FIELD_NUMBER

public static final int VALIDATION_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 ParameterSpec getDefaultInstance()
Returns
Type Description
ParameterSpec

getDescriptor()

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

newBuilder()

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

newBuilder(ParameterSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ParameterSpec getDefaultInstanceForType()
Returns
Type Description
ParameterSpec

getDefaultValue()

public ParamValue getDefaultValue()

Optional. The default value of the parameter.

.google.cloud.cloudsecuritycompliance.v1.ParamValue default_value = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ParamValue

The defaultValue.

getDefaultValueOrBuilder()

public ParamValueOrBuilder getDefaultValueOrBuilder()

Optional. The default value of the parameter.

.google.cloud.cloudsecuritycompliance.v1.ParamValue default_value = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ParamValueOrBuilder

getDescription()

public String getDescription()

Optional. The description of the parameter. The maximum length is 2000 characters.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The description of the parameter. The maximum length is 2000 characters.

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

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Optional. The display name of the parameter. The maximum length is 200 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The display name of the parameter. The maximum length is 200 characters.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getIsRequired()

public boolean getIsRequired()

Required. if the parameter is required

bool is_required = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

The isRequired.

getName()

public String getName()

Required. The name of the parameter.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the parameter.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubParameters(int index)

public ParameterSpec getSubParameters(int index)

Optional. ParameterSpec for oneof attributes.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSpec sub_parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ParameterSpec

getSubParametersCount()

public int getSubParametersCount()

Optional. ParameterSpec for oneof attributes.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSpec sub_parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSubParametersList()

public List<ParameterSpec> getSubParametersList()

Optional. ParameterSpec for oneof attributes.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSpec sub_parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ParameterSpec>

getSubParametersOrBuilder(int index)

public ParameterSpecOrBuilder getSubParametersOrBuilder(int index)

Optional. ParameterSpec for oneof attributes.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSpec sub_parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ParameterSpecOrBuilder

getSubParametersOrBuilderList()

public List<? extends ParameterSpecOrBuilder> getSubParametersOrBuilderList()

Optional. ParameterSpec for oneof attributes.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSpec sub_parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.cloudsecuritycompliance.v1.ParameterSpecOrBuilder>

getSubstitutionRules(int index)

public ParameterSubstitutionRule getSubstitutionRules(int index)

Optional. List of parameter substitutions.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSubstitutionRule substitution_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ParameterSubstitutionRule

getSubstitutionRulesCount()

public int getSubstitutionRulesCount()

Optional. List of parameter substitutions.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSubstitutionRule substitution_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSubstitutionRulesList()

public List<ParameterSubstitutionRule> getSubstitutionRulesList()

Optional. List of parameter substitutions.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSubstitutionRule substitution_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ParameterSubstitutionRule>

getSubstitutionRulesOrBuilder(int index)

public ParameterSubstitutionRuleOrBuilder getSubstitutionRulesOrBuilder(int index)

Optional. List of parameter substitutions.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSubstitutionRule substitution_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ParameterSubstitutionRuleOrBuilder

getSubstitutionRulesOrBuilderList()

public List<? extends ParameterSubstitutionRuleOrBuilder> getSubstitutionRulesOrBuilderList()

Optional. List of parameter substitutions.

repeated .google.cloud.cloudsecuritycompliance.v1.ParameterSubstitutionRule substitution_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.cloudsecuritycompliance.v1.ParameterSubstitutionRuleOrBuilder>

getValidation()

public Validation getValidation()

Optional. The allowed set of values for the parameter.

.google.cloud.cloudsecuritycompliance.v1.Validation validation = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Validation

The validation.

getValidationOrBuilder()

public ValidationOrBuilder getValidationOrBuilder()

Optional. The allowed set of values for the parameter.

.google.cloud.cloudsecuritycompliance.v1.Validation validation = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ValidationOrBuilder

getValueType()

public ParameterSpec.ValueType getValueType()

Required. Parameter value type.

.google.cloud.cloudsecuritycompliance.v1.ParameterSpec.ValueType value_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ParameterSpec.ValueType

The valueType.

getValueTypeValue()

public int getValueTypeValue()

Required. Parameter value type.

.google.cloud.cloudsecuritycompliance.v1.ParameterSpec.ValueType value_type = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for valueType.

hasDefaultValue()

public boolean hasDefaultValue()

Optional. The default value of the parameter.

.google.cloud.cloudsecuritycompliance.v1.ParamValue default_value = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the defaultValue field is set.

hasValidation()

public boolean hasValidation()

Optional. The allowed set of values for the parameter.

.google.cloud.cloudsecuritycompliance.v1.Validation validation = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the validation field is set.

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 ParameterSpec.Builder newBuilderForType()
Returns
Type Description
ParameterSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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