Connectors V1 API - Class Google::Cloud::Connectors::V1::RuntimeEntitySchema::Field (v0.1.0)

Reference documentation and code samples for the Connectors V1 API class Google::Cloud::Connectors::V1::RuntimeEntitySchema::Field.

Metadata of an entity field.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#additional_details

def additional_details() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.

#additional_details=

def additional_details=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
Returns
  • (::Google::Protobuf::Struct) — The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.

#data_type

def data_type() -> ::Google::Cloud::Connectors::V1::DataType
Returns

#data_type=

def data_type=(value) -> ::Google::Cloud::Connectors::V1::DataType
Parameter
Returns

#default_value

def default_value() -> ::Google::Protobuf::Value
Returns
  • (::Google::Protobuf::Value) — The following field specifies the default value of the Field provided by the external system if a value is not provided.

#default_value=

def default_value=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::Google::Protobuf::Value) — The following field specifies the default value of the Field provided by the external system if a value is not provided.
Returns
  • (::Google::Protobuf::Value) — The following field specifies the default value of the Field provided by the external system if a value is not provided.

#description

def description() -> ::String
Returns
  • (::String) — A brief description of the Field.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — A brief description of the Field.
Returns
  • (::String) — A brief description of the Field.

#field

def field() -> ::String
Returns
  • (::String) — Name of the Field.

#field=

def field=(value) -> ::String
Parameter
  • value (::String) — Name of the Field.
Returns
  • (::String) — Name of the Field.

#key

def key() -> ::Boolean
Returns
  • (::Boolean) — The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.

#key=

def key=(value) -> ::Boolean
Parameter
  • value (::Boolean) — The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
Returns
  • (::Boolean) — The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.

#nullable

def nullable() -> ::Boolean
Returns
  • (::Boolean) — Specifies whether a null value is allowed.

#nullable=

def nullable=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Specifies whether a null value is allowed.
Returns
  • (::Boolean) — Specifies whether a null value is allowed.

#readonly

def readonly() -> ::Boolean
Returns
  • (::Boolean) — Specifies if the Field is readonly.

#readonly=

def readonly=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Specifies if the Field is readonly.
Returns
  • (::Boolean) — Specifies if the Field is readonly.