Reference documentation and code samples for the Google Cloud Resource Settings V1 Client class SettingMetadata.
Metadata about a setting which is not editable by the end user.
Generated from protobuf message google.cloud.resourcesettings.v1.SettingMetadata
Namespace
Google \ Cloud \ ResourceSettings \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ display_name |
string
The human readable name for this setting. |
↳ description |
string
A detailed description of what this setting does. |
↳ read_only |
bool
A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons). |
↳ data_type |
int
The data type for this setting. |
↳ default_value |
Google\Cloud\ResourceSettings\V1\Value
The value provided by Setting.effective_value if no setting value is explicitly set. Note: not all settings have a default value. |
getDisplayName
The human readable name for this setting.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The human readable name for this setting.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
A detailed description of what this setting does.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
A detailed description of what this setting does.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadOnly
A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons).
| Returns | |
|---|---|
| Type | Description |
bool | |
setReadOnly
A flag indicating that values of this setting cannot be modified (see documentation of the specific setting for updates and reasons).
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDataType
The data type for this setting.
| Returns | |
|---|---|
| Type | Description |
int | |
setDataType
The data type for this setting.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDefaultValue
The value provided by Setting.effective_value if no setting value is explicitly set.
Note: not all settings have a default value.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\ResourceSettings\V1\Value|null | |
hasDefaultValue
clearDefaultValue
setDefaultValue
The value provided by Setting.effective_value if no setting value is explicitly set.
Note: not all settings have a default value.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\ResourceSettings\V1\Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |