API hub v1 API - Class Attribute.Types.AllowedValue (1.0.0-beta02)

public sealed class Attribute.Types.AllowedValue : IMessage<Attribute.Types.AllowedValue>, IEquatable<Attribute.Types.AllowedValue>, IDeepCloneable<Attribute.Types.AllowedValue>, IBufferMessage, IMessage

Reference documentation and code samples for the API hub v1 API class Attribute.Types.AllowedValue.

The value that can be assigned to the attribute when the data type is enum.

Inheritance

object > Attribute.Types.AllowedValue

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

AllowedValue()

public AllowedValue()

AllowedValue(AllowedValue)

public AllowedValue(Attribute.Types.AllowedValue other)
Parameter
Name Description
other AttributeTypesAllowedValue

Properties

Description

public string Description { get; set; }

Optional. The detailed description of the allowed value.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. The display name of the allowed value.

Property Value
Type Description
string

Id

public string Id { get; set; }

Required. The ID of the allowed value.

  • If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource.
  • If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Property Value
Type Description
string

Immutable

public bool Immutable { get; set; }

Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.

Property Value
Type Description
bool