Reference documentation and code samples for the Google Cloud Dataplex V1 Client class EnumValue.
Definition of Enumvalue (to be used by enum fields)
Generated from protobuf message google.cloud.dataplex.v1.AspectType.MetadataTemplate.EnumValue
Namespace
Google \ Cloud \ Dataplex \ V1 \ AspectType \ MetadataTemplateMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ index |
int
Required. Index for the enum. Cannot be modified. |
↳ name |
string
Required. Name of the enumvalue. This is the actual value that the aspect will contain. |
↳ deprecated |
string
Optional. Optional deprecation message to be set if an enum value needs to be deprecated. |
getIndex
Required. Index for the enum. Cannot be modified.
| Returns | |
|---|---|
| Type | Description |
int |
|
setIndex
Required. Index for the enum. Cannot be modified.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Required. Name of the enumvalue. This is the actual value that the aspect will contain.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Name of the enumvalue. This is the actual value that the aspect will contain.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeprecated
Optional. Optional deprecation message to be set if an enum value needs to be deprecated.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeprecated
Optional. Optional deprecation message to be set if an enum value needs to be deprecated.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|