azure.agrifood.farming.aio.operations package¶
-
class
azure.agrifood.farming.aio.operations.
ApplicationDataOperations
(client, config, serializer, deserializer)[source]¶ ApplicationDataOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(farmer_id: str, application_data_id: str, application_data: Optional[_models.ApplicationData] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.ApplicationData[source]¶ Creates or updates an application data resource under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer.
application_data_id (str) – ID of the application data resource.
application_data (ApplicationData) – Application data resource payload to create or update.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ApplicationData, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, application_data_id: str, **kwargs: Any) → None[source]¶ Deletes a specified application data resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(farmer_id: str, application_data_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.ApplicationData[source]¶ Get a specified application data resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ApplicationData, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(min_avg_material: Optional[float] = None, max_avg_material: Optional[float] = None, min_total_material: Optional[float] = None, max_total_material: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, operation_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.ApplicationDataListResponse][source]¶ Returns a paginated list of application data resources across all farmers.
- Parameters
min_avg_material (float) – Minimum average amount of material applied during the application (inclusive).
max_avg_material (float) – Maximum average amount of material applied during the application (inclusive).
min_total_material (float) – Minimum total amount of material applied during the application (inclusive).
max_total_material (float) – Maximum total amount of material applied during the application (inclusive).
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data.
operation_boundary_ids (list[str]) – Operation boundary IDs associated with operation data.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_area (float) – Minimum area for which operation was applied (inclusive).
max_area (float) – Maximum area for which operation was applied (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ApplicationDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, min_avg_material: Optional[float] = None, max_avg_material: Optional[float] = None, min_total_material: Optional[float] = None, max_total_material: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, operation_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.ApplicationDataListResponse][source]¶ Returns a paginated list of application data resources under a particular farm.
- Parameters
farmer_id (str) – ID of the associated farmer.
min_avg_material (float) – Minimum average amount of material applied during the application (inclusive).
max_avg_material (float) – Maximum average amount of material applied during the application (inclusive).
min_total_material (float) – Minimum total amount of material applied during the application (inclusive).
max_total_material (float) – Maximum total amount of material applied during the application (inclusive).
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data.
operation_boundary_ids (list[str]) – Operation boundary IDs associated with operation data.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_area (float) – Minimum area for which operation was applied (inclusive).
max_area (float) – Maximum area for which operation was applied (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ApplicationDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
AttachmentsOperations
(client, config, serializer, deserializer)[source]¶ AttachmentsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(farmer_id: str, attachment_id: str, file: Optional[IO] = None, farmer_id1: Optional[str] = None, resource_id: Optional[str] = None, resource_type: Optional[str] = None, original_file_name: Optional[str] = None, id: Optional[str] = None, status: Optional[str] = None, created_date_time: Optional[str] = None, modified_date_time: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, e_tag: Optional[str] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Attachment[source]¶ Creates or updates an attachment resource under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer resource.
attachment_id (str) – ID of the attachment resource.
file (IO) – File to be uploaded.
farmer_id1 (str) – Farmer id for this attachment.
resource_id (str) – Associated Resource id for this attachment.
resource_type (str) – Associated Resource type for this attachment i.e. Farmer, Farm, Field, SeasonalField, Boundary, FarmOperationApplicationData, HarvestData, TillageData, PlantingData.
original_file_name (str) – Original File Name for this attachment.
id (str) – Unique id.
status (str) – Status of the resource.
created_date_time (str) – Date when resource was created.
modified_date_time (str) – Date when resource was last modified.
name (str) – Name to identify resource.
description (str) – Textual description of resource.
e_tag (str) – The ETag value to implement optimistic concurrency.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Attachment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, attachment_id: str, **kwargs: Any) → None[source]¶ Deletes a specified attachment resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
download
(farmer_id: str, attachment_id: str, **kwargs: Any) → IO[source]¶ Downloads and returns attachment as response for the given input filePath.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
IO, or the result of cls(response)
- Return type
IO
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(farmer_id: str, attachment_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Attachment[source]¶ Gets a specified attachment resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Attachment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, resource_ids: Optional[List[str]] = None, resource_types: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.AttachmentListResponse][source]¶ Returns a paginated list of attachment resources under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer.
resource_types (list[str]) – Resource Types of the resource.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either AttachmentListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
BoundariesOperations
(client, config, serializer, deserializer)[source]¶ BoundariesOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_cascade_delete_job
(job_id: str, farmer_id: str, boundary_id: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.CascadeDeleteJob][source]¶ Create a cascade delete job for specified boundary.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either CascadeDeleteJob or the result of cls(response)
- Return type
- Raises
-
async
create_or_update
(farmer_id: str, boundary_id: str, boundary: Optional[_models.Boundary] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Boundary[source]¶ Creates or updates a boundary resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Boundary, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, boundary_id: str, **kwargs: Any) → None[source]¶ Deletes a specified boundary resource under a particular farmer.
-
async
get
(farmer_id: str, boundary_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Boundary[source]¶ Gets a specified boundary resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Boundary, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.CascadeDeleteJob[source]¶ Get cascade delete job for specified boundary.
-
async
get_overlap
(farmer_id: str, boundary_id: str, other_farmer_id: str, other_boundary_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.BoundaryOverlapResponse[source]¶ Returns overlapping acreage between two boundary Ids.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
BoundaryOverlapResponse, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(is_primary: Optional[bool] = None, parent_type: Optional[str] = None, parent_ids: Optional[List[str]] = None, min_acreage: Optional[float] = None, max_acreage: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.BoundaryListResponse][source]¶ Returns a paginated list of boundary resources across all farmers.
- Parameters
is_primary (bool) – Is the boundary primary.
parent_type (str) – Type of the parent it belongs to.
min_acreage (float) – Minimum acreage of the boundary (inclusive).
max_acreage (float) – Maximum acreage of the boundary (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either BoundaryListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, is_primary: Optional[bool] = None, parent_type: Optional[str] = None, parent_ids: Optional[List[str]] = None, min_acreage: Optional[float] = None, max_acreage: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.BoundaryListResponse][source]¶ Returns a paginated list of boundary resources under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer.
is_primary (bool) – Is the boundary primary.
parent_type (str) – Type of the parent it belongs to.
min_acreage (float) – Minimum acreage of the boundary (inclusive).
max_acreage (float) – Maximum acreage of the boundary (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either BoundaryListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
search
(query: Optional[_models.SearchBoundaryQuery] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.BoundaryListResponse][source]¶ Search for boundaries across all farmers by fields and intersecting geometry.
- Parameters
query (SearchBoundaryQuery) – Query filters.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either BoundaryListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
search_by_farmer_id
(farmer_id: str, query: Optional[_models.SearchBoundaryQuery] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.BoundaryListResponse][source]¶ Search for boundaries by fields and intersecting geometry.
- Parameters
farmer_id (str) – ID of the farmer.
query (SearchBoundaryQuery) – Query filters.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either BoundaryListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
CropsOperations
(client, config, serializer, deserializer)[source]¶ CropsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(crop_id: str, crop: Optional[_models.Crop] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Crop[source]¶ Creates or updates a crop resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Crop, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(crop_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Crop[source]¶ Gets a specified crop resource.
-
list
(phenotypes: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.CropListResponse][source]¶ Returns a paginated list of crop resources.
- Parameters
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either CropListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
CropVarietiesOperations
(client, config, serializer, deserializer)[source]¶ CropVarietiesOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(crop_id: str, crop_variety_id: str, crop_variety: Optional[_models.CropVariety] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.CropVariety[source]¶ Creates or updates a crop variety resource.
- Parameters
crop_id (str) – ID of the crop resource.
crop_variety_id (str) – ID of the crop variety resource.
crop_variety (CropVariety) – Crop variety resource payload to create or update.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
CropVariety, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(crop_id: str, crop_variety_id: str, **kwargs: Any) → None[source]¶ Deletes a specified crop variety resource under a particular crop.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(crop_id: str, crop_variety_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.CropVariety[source]¶ Gets a specified crop variety resource under a particular crop.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
CropVariety, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(crop_ids: Optional[List[str]] = None, brands: Optional[List[str]] = None, products: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.CropVarietyListResponse][source]¶ Returns a paginated list of crop variety resources across all crops.
- Parameters
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either CropVarietyListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_crop_id
(crop_id: str, crop_ids: Optional[List[str]] = None, brands: Optional[List[str]] = None, products: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.CropVarietyListResponse][source]¶ Returns a paginated list of crop variety resources under a particular crop.
- Parameters
crop_id (str) – ID of the associated crop.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either CropVarietyListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
FarmersOperations
(client, config, serializer, deserializer)[source]¶ FarmersOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_cascade_delete_job
(job_id: str, farmer_id: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.CascadeDeleteJob][source]¶ Create a cascade delete job for specified farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either CascadeDeleteJob or the result of cls(response)
- Return type
- Raises
-
async
create_or_update
(farmer_id: str, farmer: Optional[_models.Farmer] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Farmer[source]¶ Creates or updates a farmer resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Farmer, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(farmer_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Farmer[source]¶ Gets a specified farmer resource.
-
async
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.CascadeDeleteJob[source]¶ Get a cascade delete job for specified farmer.
-
list
(ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.FarmerListResponse][source]¶ Returns a paginated list of farmer resources.
- Parameters
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either FarmerListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
FarmOperationsOperations
(client, config, serializer, deserializer)[source]¶ FarmOperationsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_data_ingestion_job
(job_id: str, job: Optional[_models.FarmOperationDataIngestionJob] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.FarmOperationDataIngestionJob][source]¶ Create a farm operation data ingestion job.
- Parameters
job_id (str) – Job ID supplied by user.
job (FarmOperationDataIngestionJob) – Job parameters supplied by user.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either FarmOperationDataIngestionJob or the result of cls(response)
- Return type
- Raises
-
async
get_data_ingestion_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.FarmOperationDataIngestionJob[source]¶ Get a farm operation data ingestion job.
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
FarmsOperations
(client, config, serializer, deserializer)[source]¶ FarmsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_cascade_delete_job
(job_id: str, farmer_id: str, farm_id: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.CascadeDeleteJob][source]¶ Create a cascade delete job for specified farm.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either CascadeDeleteJob or the result of cls(response)
- Return type
- Raises
-
async
create_or_update
(farmer_id: str, farm_id: str, farm: Optional[_models.Farm] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Farm[source]¶ Creates or updates a farm resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Farm, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, farm_id: str, **kwargs: Any) → None[source]¶ Deletes a specified farm resource under a particular farmer.
-
async
get
(farmer_id: str, farm_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Farm[source]¶ Gets a specified farm resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Farm, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.CascadeDeleteJob[source]¶ Get a cascade delete job for specified farm.
-
list
(ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.FarmListResponse][source]¶ Returns a paginated list of farm resources across all farmers.
- Parameters
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either FarmListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.FarmListResponse][source]¶ Returns a paginated list of farm resources under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either FarmListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
FieldsOperations
(client, config, serializer, deserializer)[source]¶ FieldsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_cascade_delete_job
(job_id: str, farmer_id: str, field_id: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.CascadeDeleteJob][source]¶ Create a cascade delete job for specified field.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either CascadeDeleteJob or the result of cls(response)
- Return type
- Raises
-
async
create_or_update
(farmer_id: str, field_id: str, field: Optional[_models.Field] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Field[source]¶ Creates or Updates a field resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Field, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, field_id: str, **kwargs: Any) → None[source]¶ Deletes a specified field resource under a particular farmer.
-
async
get
(farmer_id: str, field_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Field[source]¶ Gets a specified field resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Field, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.CascadeDeleteJob[source]¶ Get a cascade delete job for specified field.
-
list
(farm_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.FieldListResponse][source]¶ Returns a paginated list of field resources across all farmers.
- Parameters
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either FieldListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, farm_ids: Optional[List[str]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.FieldListResponse][source]¶ Returns a paginated list of field resources under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either FieldListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
HarvestDataOperations
(client, config, serializer, deserializer)[source]¶ HarvestDataOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(farmer_id: str, harvest_data_id: str, harvest_data: Optional[_models.HarvestData] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.HarvestData[source]¶ Creates or updates harvest data resource under a particular farmer.
- Parameters
farmer_id (str) – ID of the farmer.
harvest_data_id (str) – ID of the harvest data resource.
harvest_data (HarvestData) – Harvest data resource payload to create or update.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
HarvestData, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, harvest_data_id: str, **kwargs: Any) → None[source]¶ Deletes a specified harvest data resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(farmer_id: str, harvest_data_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.HarvestData[source]¶ Get a specified harvest data resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
HarvestData, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(min_total_yield: Optional[float] = None, max_total_yield: Optional[float] = None, min_avg_yield: Optional[float] = None, max_avg_yield: Optional[float] = None, min_total_wet_mass: Optional[float] = None, max_total_wet_mass: Optional[float] = None, min_avg_wet_mass: Optional[float] = None, max_avg_wet_mass: Optional[float] = None, min_avg_moisture: Optional[float] = None, max_avg_moisture: Optional[float] = None, min_avg_speed: Optional[float] = None, max_avg_speed: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, operation_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.HarvestDataListResponse][source]¶ Returns a paginated list of harvest data resources across all farmers.
- Parameters
min_total_yield (float) – Minimum Yield value(inclusive).
max_total_yield (float) – Maximum Yield value (inclusive).
min_avg_yield (float) – Minimum AvgYield value(inclusive).
max_avg_yield (float) – Maximum AvgYield value (inclusive).
min_total_wet_mass (float) – Minimum Total WetMass value(inclusive).
max_total_wet_mass (float) – Maximum Total WetMass value (inclusive).
min_avg_wet_mass (float) – Minimum AvgWetMass value(inclusive).
max_avg_wet_mass (float) – Maximum AvgWetMass value (inclusive).
min_avg_moisture (float) – Minimum AvgMoisture value(inclusive).
max_avg_moisture (float) – Maximum AvgMoisture value (inclusive).
min_avg_speed (float) – Minimum AvgSpeed value(inclusive).
max_avg_speed (float) – Maximum AvgSpeed value (inclusive).
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data.
operation_boundary_ids (list[str]) – Operation boundary IDs associated with operation data.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_area (float) – Minimum area for which operation was applied (inclusive).
max_area (float) – Maximum area for which operation was applied (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either HarvestDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, min_total_yield: Optional[float] = None, max_total_yield: Optional[float] = None, min_avg_yield: Optional[float] = None, max_avg_yield: Optional[float] = None, min_total_wet_mass: Optional[float] = None, max_total_wet_mass: Optional[float] = None, min_avg_wet_mass: Optional[float] = None, max_avg_wet_mass: Optional[float] = None, min_avg_moisture: Optional[float] = None, max_avg_moisture: Optional[float] = None, min_avg_speed: Optional[float] = None, max_avg_speed: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, operation_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.HarvestDataListResponse][source]¶ Returns a paginated list of harvest data resources under a particular farm.
- Parameters
farmer_id (str) – ID of the associated farmer.
min_total_yield (float) – Minimum Yield value(inclusive).
max_total_yield (float) – Maximum Yield value (inclusive).
min_avg_yield (float) – Minimum AvgYield value(inclusive).
max_avg_yield (float) – Maximum AvgYield value (inclusive).
min_total_wet_mass (float) – Minimum Total WetMass value(inclusive).
max_total_wet_mass (float) – Maximum Total WetMass value (inclusive).
min_avg_wet_mass (float) – Minimum AvgWetMass value(inclusive).
max_avg_wet_mass (float) – Maximum AvgWetMass value (inclusive).
min_avg_moisture (float) – Minimum AvgMoisture value(inclusive).
max_avg_moisture (float) – Maximum AvgMoisture value (inclusive).
min_avg_speed (float) – Minimum AvgSpeed value(inclusive).
max_avg_speed (float) – Maximum AvgSpeed value (inclusive).
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data.
operation_boundary_ids (list[str]) – Operation boundary IDs associated with operation data.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_area (float) – Minimum area for which operation was applied (inclusive).
max_area (float) – Maximum area for which operation was applied (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either HarvestDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
ImageProcessingOperations
(client, config, serializer, deserializer)[source]¶ ImageProcessingOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_rasterize_job
(job_id: str, job: Optional[_models.ImageProcessingRasterizeJob] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.ImageProcessingRasterizeJob][source]¶ Create a ImageProcessing Rasterize job.
- Parameters
job_id (str) – JobId provided by user.
job (ImageProcessingRasterizeJob) – Job parameters supplied by user.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either ImageProcessingRasterizeJob or the result of cls(response)
- Return type
- Raises
-
async
get_rasterize_job
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.ImageProcessingRasterizeJob[source]¶ Get ImageProcessing Rasterize job’s details.
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
OAuthProvidersOperations
(client, config, serializer, deserializer)[source]¶ OAuthProvidersOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(oauth_provider_id: str, oauth_provider: Optional[_models.OAuthProvider] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.OAuthProvider[source]¶ Creates or updates an oauthProvider resource.
- Parameters
oauth_provider_id (str) – ID of oauthProvider resource.
oauth_provider (OAuthProvider) – OauthProvider resource payload to create or update.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
OAuthProvider, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(oauth_provider_id: str, **kwargs: Any) → None[source]¶ Deletes an specified oauthProvider resource.
-
async
get
(oauth_provider_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.OAuthProvider[source]¶ Get a specified oauthProvider resource.
-
list
(ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.OAuthProviderListResponse][source]¶ Returns a paginated list of oauthProvider resources.
- Parameters
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either OAuthProviderListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
OAuthTokensOperations
(client, config, serializer, deserializer)[source]¶ OAuthTokensOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_cascade_delete_job
(job_id: str, farmer_id: str, oauth_provider_id: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.CascadeDeleteJob][source]¶ Create a cascade delete job for OAuth tokens.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either CascadeDeleteJob or the result of cls(response)
- Return type
- Raises
-
async
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.CascadeDeleteJob[source]¶ Get cascade delete job details for OAuth tokens for specified job ID.
-
async
get_o_auth_connection_link
(connect_request: Optional[_models.OAuthConnectRequest] = None, **kwargs: Any) → str[source]¶ Returns Connection link needed in the OAuth flow.
- Parameters
connect_request (OAuthConnectRequest) – OAuth Connect Request.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
str, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(auth_provider_ids: Optional[List[str]] = None, farmer_ids: Optional[List[str]] = None, is_valid: Optional[bool] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.OAuthTokenListResponse][source]¶ Returns a list of OAuthToken documents.
- Parameters
is_valid (bool) – If the token object is valid.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either OAuthTokenListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
PlantingDataOperations
(client, config, serializer, deserializer)[source]¶ PlantingDataOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(farmer_id: str, planting_data_id: str, planting_data: Optional[_models.PlantingData] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.PlantingData[source]¶ Creates or updates an planting data resource under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer.
planting_data_id (str) – ID of the planting data resource.
planting_data (PlantingData) – Planting data resource payload to create or update.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PlantingData, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, planting_data_id: str, **kwargs: Any) → None[source]¶ Deletes a specified planting data resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(farmer_id: str, planting_data_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.PlantingData[source]¶ Get a specified planting data resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PlantingData, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(min_avg_planting_rate: Optional[float] = None, max_avg_planting_rate: Optional[float] = None, min_total_material: Optional[float] = None, max_total_material: Optional[float] = None, min_avg_material: Optional[float] = None, max_avg_material: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, operation_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.PlantingDataListResponse][source]¶ Returns a paginated list of planting data resources across all farmers.
- Parameters
min_avg_planting_rate (float) – Minimum AvgPlantingRate value(inclusive).
max_avg_planting_rate (float) – Maximum AvgPlantingRate value (inclusive).
min_total_material (float) – Minimum TotalMaterial value(inclusive).
max_total_material (float) – Maximum TotalMaterial value (inclusive).
min_avg_material (float) – Minimum AvgMaterial value(inclusive).
max_avg_material (float) – Maximum AvgMaterial value (inclusive).
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data.
operation_boundary_ids (list[str]) – Operation boundary IDs associated with operation data.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_area (float) – Minimum area for which operation was applied (inclusive).
max_area (float) – Maximum area for which operation was applied (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PlantingDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, min_avg_planting_rate: Optional[float] = None, max_avg_planting_rate: Optional[float] = None, min_total_material: Optional[float] = None, max_total_material: Optional[float] = None, min_avg_material: Optional[float] = None, max_avg_material: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, operation_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.PlantingDataListResponse][source]¶ Returns a paginated list of planting data resources under a particular farm.
- Parameters
farmer_id (str) – ID of the associated farmer.
min_avg_planting_rate (float) – Minimum AvgPlantingRate value(inclusive).
max_avg_planting_rate (float) – Maximum AvgPlantingRate value (inclusive).
min_total_material (float) – Minimum TotalMaterial value(inclusive).
max_total_material (float) – Maximum TotalMaterial value (inclusive).
min_avg_material (float) – Minimum AvgMaterial value(inclusive).
max_avg_material (float) – Maximum AvgMaterial value (inclusive).
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data.
operation_boundary_ids (list[str]) – Operation boundary IDs associated with operation data.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_area (float) – Minimum area for which operation was applied (inclusive).
max_area (float) – Maximum area for which operation was applied (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PlantingDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
ScenesOperations
(client, config, serializer, deserializer)[source]¶ ScenesOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_satellite_data_ingestion_job
(job_id: str, job: Optional[_models.SatelliteDataIngestionJob] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.SatelliteDataIngestionJob][source]¶ Create a satellite data ingestion job.
- Parameters
job_id (str) – JobId provided by user.
job (SatelliteDataIngestionJob) – Job parameters supplied by user.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either SatelliteDataIngestionJob or the result of cls(response)
- Return type
- Raises
-
async
download
(file_path: str, **kwargs: Any) → IO[source]¶ Downloads and returns file stream as response for the given input filePath.
-
async
get_satellite_data_ingestion_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.SatelliteDataIngestionJob[source]¶ Get a satellite data ingestion job.
-
list
(farmer_id: str, boundary_id: str, provider: str = 'Microsoft', source: Optional[str] = 'Sentinel_2_L2A', start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, max_cloud_coverage_percentage: Optional[float] = 100, max_dark_pixel_coverage_percentage: Optional[float] = 100, image_names: Optional[List[str]] = None, image_resolutions: Optional[List[float]] = None, image_formats: Optional[List[str]] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.SceneListResponse][source]¶ Returns a paginated list of scene resources.
- Parameters
farmer_id (str) – FarmerId.
boundary_id (str) – BoundaryId.
provider (str) – Provider name of scene data.
source (str) – Source name of scene data, default value Sentinel_2_L2A (Sentinel 2 L2A).
start_date_time (datetime) – Scene start UTC datetime (inclusive), sample format: yyyy-MM-ddThh:mm:ssZ.
end_date_time (datetime) – Scene end UTC datetime (inclusive), sample format: yyyy-MM-dThh:mm:ssZ.
max_cloud_coverage_percentage (float) – Filter scenes with cloud coverage percentage less than max value. Range [0 to 100.0].
max_dark_pixel_coverage_percentage (float) – Filter scenes with dark pixel coverage percentage less than max value. Range [0 to 100.0].
image_names (list[str]) – List of image names to be filtered.
image_resolutions (list[float]) – List of image resolutions in meters to be filtered.
image_formats (list[str]) – List of image formats to be filtered.
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SceneListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
SeasonalFieldsOperations
(client, config, serializer, deserializer)[source]¶ SeasonalFieldsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_cascade_delete_job
(job_id: str, farmer_id: str, seasonal_field_id: str, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.CascadeDeleteJob][source]¶ Create a cascade delete job for specified seasonal field.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either CascadeDeleteJob or the result of cls(response)
- Return type
- Raises
-
async
create_or_update
(farmer_id: str, seasonal_field_id: str, seasonal_field: Optional[_models.SeasonalField] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.SeasonalField[source]¶ Creates or Updates a seasonal field resource under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer resource.
seasonal_field_id (str) – ID of the seasonal field resource.
seasonal_field (SeasonalField) – Seasonal field resource payload to create or update.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SeasonalField, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, seasonal_field_id: str, **kwargs: Any) → None[source]¶ Deletes a specified seasonal-field resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(farmer_id: str, seasonal_field_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.SeasonalField[source]¶ Gets a specified seasonal field resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
SeasonalField, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get_cascade_delete_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.CascadeDeleteJob[source]¶ Get cascade delete job for specified seasonal field.
-
list
(farm_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, season_ids: Optional[List[str]] = None, crop_variety_ids: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, min_avg_yield_value: Optional[float] = None, max_avg_yield_value: Optional[float] = None, avg_yield_unit: Optional[str] = None, min_avg_seed_population_value: Optional[float] = None, max_avg_seed_population_value: Optional[float] = None, avg_seed_population_unit: Optional[str] = None, min_planting_date_time: Optional[datetime.datetime] = None, max_planting_date_time: Optional[datetime.datetime] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.SeasonalFieldListResponse][source]¶ Returns a paginated list of seasonal field resources across all farmers.
- Parameters
crop_variety_ids (list[str]) – CropVarietyIds of the resource.
min_avg_yield_value (float) – Minimum average yield value of the seasonal field(inclusive).
max_avg_yield_value (float) – Maximum average yield value of the seasonal field(inclusive).
avg_yield_unit (str) – Unit of the average yield value attribute.
min_avg_seed_population_value (float) – Minimum average seed population value of the seasonal field(inclusive).
max_avg_seed_population_value (float) – Maximum average seed population value of the seasonal field(inclusive).
avg_seed_population_unit (str) – Unit of average seed population value attribute.
min_planting_date_time (datetime) – Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.
max_planting_date_time (datetime) – Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SeasonalFieldListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, farm_ids: Optional[List[str]] = None, field_ids: Optional[List[str]] = None, season_ids: Optional[List[str]] = None, crop_variety_ids: Optional[List[str]] = None, crop_ids: Optional[List[str]] = None, min_avg_yield_value: Optional[float] = None, max_avg_yield_value: Optional[float] = None, avg_yield_unit: Optional[str] = None, min_avg_seed_population_value: Optional[float] = None, max_avg_seed_population_value: Optional[float] = None, avg_seed_population_unit: Optional[str] = None, min_planting_date_time: Optional[datetime.datetime] = None, max_planting_date_time: Optional[datetime.datetime] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.SeasonalFieldListResponse][source]¶ Returns a paginated list of seasonal field resources under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer.
crop_variety_ids (list[str]) – CropVarietyIds of the resource.
min_avg_yield_value (float) – Minimum average yield value of the seasonal field(inclusive).
max_avg_yield_value (float) – Maximum average yield value of the seasonal field(inclusive).
avg_yield_unit (str) – Unit of the average yield value attribute.
min_avg_seed_population_value (float) – Minimum average seed population value of the seasonal field(inclusive).
max_avg_seed_population_value (float) – Maximum average seed population value of the seasonal field(inclusive).
avg_seed_population_unit (str) – Unit of average seed population value attribute.
min_planting_date_time (datetime) – Minimum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.
max_planting_date_time (datetime) – Maximum planting datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SeasonalFieldListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
SeasonsOperations
(client, config, serializer, deserializer)[source]¶ SeasonsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(season_id: str, season: Optional[_models.Season] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Season[source]¶ Creates or updates a season resource.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Season, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(season_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.Season[source]¶ Gets a specified season resource.
-
list
(min_start_date_time: Optional[datetime.datetime] = None, max_start_date_time: Optional[datetime.datetime] = None, min_end_date_time: Optional[datetime.datetime] = None, max_end_date_time: Optional[datetime.datetime] = None, years: Optional[List[int]] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.SeasonListResponse][source]¶ Returns a paginated list of season resources.
- Parameters
min_start_date_time (datetime) – Minimum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.
max_start_date_time (datetime) – Maximum season start datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.
min_end_date_time (datetime) – Minimum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.
max_end_date_time (datetime) – Maximum season end datetime, sample format: yyyy-MM-ddTHH:mm:ssZ.
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either SeasonListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
TillageDataOperations
(client, config, serializer, deserializer)[source]¶ TillageDataOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
create_or_update
(farmer_id: str, tillage_data_id: str, tillage_data: Optional[_models.TillageData] = None, **kwargs: Any) → azure.agrifood.farming.models._models_py3.TillageData[source]¶ Creates or updates an tillage data resource under a particular farmer.
- Parameters
farmer_id (str) – ID of the associated farmer.
tillage_data_id (str) – ID of the tillage data resource.
tillage_data (TillageData) – Tillage data resource payload to create or update.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
TillageData, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete
(farmer_id: str, tillage_data_id: str, **kwargs: Any) → None[source]¶ Deletes a specified tillage data resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get
(farmer_id: str, tillage_data_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.TillageData[source]¶ Get a specified tillage data resource under a particular farmer.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
TillageData, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(min_tillage_depth: Optional[float] = None, max_tillage_depth: Optional[float] = None, min_tillage_pressure: Optional[float] = None, max_tillage_pressure: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, operation_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.TillageDataListResponse][source]¶ Returns a paginated list of tillage data resources across all farmers.
- Parameters
min_tillage_depth (float) – Minimum measured tillage depth (inclusive).
max_tillage_depth (float) – Maximum measured tillage depth (inclusive).
min_tillage_pressure (float) – Minimum pressure applied by a tillage implement (inclusive).
max_tillage_pressure (float) – Maximum pressure applied by a tillage implement (inclusive).
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data.
operation_boundary_ids (list[str]) – Operation boundary IDs associated with operation data.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_area (float) – Minimum area for which operation was applied (inclusive).
max_area (float) – Maximum area for which operation was applied (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either TillageDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_farmer_id
(farmer_id: str, min_tillage_depth: Optional[float] = None, max_tillage_depth: Optional[float] = None, min_tillage_pressure: Optional[float] = None, max_tillage_pressure: Optional[float] = None, sources: Optional[List[str]] = None, associated_boundary_ids: Optional[List[str]] = None, operation_boundary_ids: Optional[List[str]] = None, min_operation_start_date_time: Optional[datetime.datetime] = None, max_operation_start_date_time: Optional[datetime.datetime] = None, min_operation_end_date_time: Optional[datetime.datetime] = None, max_operation_end_date_time: Optional[datetime.datetime] = None, min_operation_modified_date_time: Optional[datetime.datetime] = None, max_operation_modified_date_time: Optional[datetime.datetime] = None, min_area: Optional[float] = None, max_area: Optional[float] = None, ids: Optional[List[str]] = None, names: Optional[List[str]] = None, property_filters: Optional[List[str]] = None, statuses: Optional[List[str]] = None, min_created_date_time: Optional[datetime.datetime] = None, max_created_date_time: Optional[datetime.datetime] = None, min_last_modified_date_time: Optional[datetime.datetime] = None, max_last_modified_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.TillageDataListResponse][source]¶ Returns a paginated list of tillage data resources under a particular farm.
- Parameters
farmer_id (str) – ID of the associated farmer.
min_tillage_depth (float) – Minimum measured tillage depth (inclusive).
max_tillage_depth (float) – Maximum measured tillage depth (inclusive).
min_tillage_pressure (float) – Minimum pressure applied by a tillage implement (inclusive).
max_tillage_pressure (float) – Maximum pressure applied by a tillage implement (inclusive).
associated_boundary_ids (list[str]) – Boundary IDs associated with operation data.
operation_boundary_ids (list[str]) – Operation boundary IDs associated with operation data.
min_operation_start_date_time (datetime) – Minimum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_start_date_time (datetime) – Maximum start date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_end_date_time (datetime) – Minimum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_end_date_time (datetime) – Maximum end date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_operation_modified_date_time (datetime) – Minimum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
max_operation_modified_date_time (datetime) – Maximum modified date-time of the operation data, sample format: yyyy-MM-ddTHH:mm:ssZ (inclusive).
min_area (float) – Minimum area for which operation was applied (inclusive).
max_area (float) – Maximum area for which operation was applied (inclusive).
property_filters (list[str]) – Filters on key-value pairs within the Properties object. eg. “{testKey} eq {testValue}”.
min_created_date_time (datetime) – Minimum creation date of resource (inclusive).
max_created_date_time (datetime) – Maximum creation date of resource (inclusive).
min_last_modified_date_time (datetime) – Minimum last modified date of resource (inclusive).
max_last_modified_date_time (datetime) – Maximum last modified date of resource (inclusive).
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either TillageDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶
-
class
azure.agrifood.farming.aio.operations.
WeatherOperations
(client, config, serializer, deserializer)[source]¶ WeatherOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
async
begin_create_data_delete_job
(job_id: str, job: Optional[_models.WeatherDataDeleteJob] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.WeatherDataDeleteJob][source]¶ Create a weather data delete job.
- Parameters
job_id (str) – Job ID supplied by end user.
job (WeatherDataDeleteJob) – Job parameters supplied by user.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either WeatherDataDeleteJob or the result of cls(response)
- Return type
- Raises
-
async
begin_create_data_ingestion_job
(job_id: str, job: Optional[_models.WeatherDataIngestionJob] = None, **kwargs: Any) → azure.core.polling._async_poller.AsyncLROPoller[azure.agrifood.farming.models._models_py3.WeatherDataIngestionJob][source]¶ Create a weather data ingestion job.
- Parameters
job_id (str) – Job id supplied by user.
job (WeatherDataIngestionJob) – Job parameters supplied by user.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or AsyncPollingMethod) – By default, your polling method will be AsyncLROBasePolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
- Returns
An instance of AsyncLROPoller that returns either WeatherDataIngestionJob or the result of cls(response)
- Return type
- Raises
-
async
get_data_delete_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.WeatherDataDeleteJob[source]¶ Get weather data delete job.
-
async
get_data_ingestion_job_details
(job_id: str, **kwargs: Any) → azure.agrifood.farming.models._models_py3.WeatherDataIngestionJob[source]¶ Get weather ingestion job.
-
list
(farmer_id: str, boundary_id: str, extension_id: str, weather_data_type: str, granularity: str, start_date_time: Optional[datetime.datetime] = None, end_date_time: Optional[datetime.datetime] = None, max_page_size: Optional[int] = 50, skip_token: Optional[str] = None, **kwargs: Any) → AsyncIterable[azure.agrifood.farming.models._models_py3.WeatherDataListResponse][source]¶ Returns a paginated list of weather data.
- Parameters
farmer_id (str) – Farmer ID.
boundary_id (str) – Boundary ID.
extension_id (str) – ID of the weather extension.
weather_data_type (str) – Type of weather data (forecast/historical).
granularity (str) – Granularity of weather data (daily/hourly).
start_date_time (datetime) – Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.
end_date_time (datetime) – Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.
max_page_size (int) – Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
skip_token (str) – Skip token for getting next set of results.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either WeatherDataListResponse or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.agrifood.farming.models' from '/mnt/vss/_work/1/s/sdk/agrifood/azure-agrifood-farming/.tox/sphinx/lib/python3.6/site-packages/azure/agrifood/farming/models/__init__.py'>¶