Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DetailsFieldSchema.
A schema for a particular details field on the Feed proto message.
Generated from protobuf message google.cloud.chronicle.v1.LogTypeSchema.DetailsFieldSchema
Namespace
Google \ Cloud \ Chronicle \ V1 \ LogTypeSchemaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field_path |
string
The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint". |
↳ display_name |
string
A human-readable name for this field. |
↳ description |
string
A human-readable description for this field. |
↳ type |
int
A type that represents both the encoding and the semantics of this field. |
↳ enum_field_schemas |
array<EnumFieldSchema>
If a field has an enum type, this is the schema describing the possible values. |
↳ required |
bool
Whether this field must be specified to have a valid feed configuration. |
↳ example_input |
string
For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input. |
↳ read_only |
bool
For those fields which are read only. |
getFieldPath
The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".
| Returns | |
|---|---|
| Type | Description |
string |
|
setFieldPath
The protocol buffer field path. For example, "details.azure_ad_context_settings.authentication.token_endpoint".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
A human-readable name for this field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
A human-readable name for this field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
A human-readable description for this field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
A human-readable description for this field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
A type that represents both the encoding and the semantics of this field.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SemanticType. |
setType
A type that represents both the encoding and the semantics of this field.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SemanticType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnumFieldSchemas
If a field has an enum type, this is the schema describing the possible values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<EnumFieldSchema> |
|
setEnumFieldSchemas
If a field has an enum type, this is the schema describing the possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
array<EnumFieldSchema>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequired
Whether this field must be specified to have a valid feed configuration.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRequired
Whether this field must be specified to have a valid feed configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExampleInput
For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.
| Returns | |
|---|---|
| Type | Description |
string |
|
setExampleInput
For those fields with input requirements that aren't adequately expressed by the SemanticType it is often useful to supply an example input.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReadOnly
For those fields which are read only.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReadOnly
For those fields which are read only.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|