Field Class

Schema of field resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

Model

Field

Constructor

Field(*, farm_id: Optional[str] = None, status: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, **kwargs)

Parameters

farm_id

str

Required

ID of the associated Farm.

status

str

Required

Status of the resource.

name

str

Required

Name to identify resource.

description

str

Required

Textual description of the resource.

properties

dict[str, any]

Required

A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string and numeral values are supported.

Variables

farmer_id

str

Farmer ID.

primary_boundary_id

str

Primary boundary id.

boundary_ids

list[str]

Boundary Ids.

id

str

Unique resource ID.

e_tag

str

The ETag value to implement optimistic concurrency.

created_date_time

datetime

Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.

modified_date_time

datetime

Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.