Skip to content

Models

QuotaUnit

Bases: Enum

Source code in src/csda_client/models.py 
10
11
12
class QuotaUnit(Enum):
    area = "area"
    filesize = "filesize"

area class-attribute instance-attribute 

area = 'area'

filesize class-attribute instance-attribute 

filesize = 'filesize'

Profile

Bases: BaseModel

Source code in src/csda_client/models.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class Profile(BaseModel):
    earthdata_username: str
    title: str | None
    first_name: str
    last_name: str
    funding_agency: str
    created_at: datetime.datetime
    updated_at: datetime.datetime
    research_area: str
    justification: str
    nda_signed: bool
    reduced_latency_data: bool
    reduced_latency_justification: str
    supporting_institution: str
    vendors: list[ProfileVendor]
    grants: list[Grant]

earthdata_username instance-attribute 

earthdata_username: str

title instance-attribute 

title: str | None

first_name instance-attribute 

first_name: str

last_name instance-attribute 

last_name: str

funding_agency instance-attribute 

funding_agency: str

created_at instance-attribute 

created_at: datetime

updated_at instance-attribute 

updated_at: datetime

research_area instance-attribute 

research_area: str

justification instance-attribute 

justification: str

nda_signed instance-attribute 

nda_signed: bool

reduced_latency_data instance-attribute 

reduced_latency_data: bool

reduced_latency_justification instance-attribute 

reduced_latency_justification: str

supporting_institution instance-attribute 

supporting_institution: str

vendors instance-attribute 

vendors: list[ProfileVendor]

grants instance-attribute 

grants: list[Grant]

ProfileVendor

Bases: BaseModel

Source code in src/csda_client/models.py 
33
34
35
36
37
38
39
40
41
42
class ProfileVendor(BaseModel):
    vendor: str
    slug: str
    quota: int
    quota_unit: QuotaUnit
    approved: bool
    approved_date: datetime.date
    expiration_date: datetime.date
    notes: str
    preview_approved: bool

vendor instance-attribute 

vendor: str

slug instance-attribute 

slug: str

quota instance-attribute 

quota: int

quota_unit instance-attribute 

quota_unit: QuotaUnit

approved instance-attribute 

approved: bool

approved_date instance-attribute 

approved_date: date

expiration_date instance-attribute 

expiration_date: date

notes instance-attribute 

notes: str

preview_approved instance-attribute 

preview_approved: bool

Vendor

Bases: BaseModel

Source code in src/csda_client/models.py 
45
46
47
48
49
50
class Vendor(BaseModel):
    id: int
    name: str
    full_name: str
    slug: str
    has_tasking: bool

id instance-attribute 

id: int

name instance-attribute 

name: str

full_name instance-attribute 

full_name: str

slug instance-attribute 

slug: str

has_tasking instance-attribute 

has_tasking: bool

Product

Bases: BaseModel

Source code in src/csda_client/models.py 
53
54
55
56
57
class Product(BaseModel):
    id: int
    slug: str
    name: str
    long_desc: str

id instance-attribute 

id: int

slug instance-attribute 

slug: str

name instance-attribute 

name: str

long_desc instance-attribute 

long_desc: str

Grant

Bases: BaseModel

Source code in src/csda_client/models.py 
60
61
62
63
64
class Grant(BaseModel):
    id: int
    grant_number: str
    start_date: datetime.date | None
    end_date: datetime.date | None

id instance-attribute 

id: int

grant_number instance-attribute 

grant_number: str

start_date instance-attribute 

start_date: date | None

end_date instance-attribute 

end_date: date | None

CreateTaskingProposal

Bases: BaseModel

Source code in src/csda_client/models.py 
67
68
69
70
71
72
class CreateTaskingProposal(BaseModel):
    name: str
    products: list[CreateTaskingProductRequest]
    research_description: str
    tasking_justification: str
    grant: int

name instance-attribute 

name: str

products instance-attribute 

products: list[CreateTaskingProductRequest]

research_description instance-attribute 

research_description: str

tasking_justification instance-attribute 

tasking_justification: str

grant instance-attribute 

grant: int

CreateTaskingProductRequest

Bases: BaseModel

Source code in src/csda_client/models.py 
75
76
77
class CreateTaskingProductRequest(BaseModel):
    product: int
    n_proposed_granules: int

product instance-attribute 

product: int

n_proposed_granules instance-attribute 

n_proposed_granules: int

TaskingProposal

Bases: BaseModel

Source code in src/csda_client/models.py 
80
81
82
83
84
85
86
87
88
89
90
class TaskingProposal(BaseModel):
    id: int
    proposal_products: list[TaskingProductRequest]
    is_draft: bool
    grant: Grant
    user: str
    name: str
    research_description: str
    tasking_justification: str
    final_decision_type: str
    decision_details: str | None

id instance-attribute 

id: int

proposal_products instance-attribute 

proposal_products: list[TaskingProductRequest]

is_draft instance-attribute 

is_draft: bool

grant instance-attribute 

grant: Grant

user instance-attribute 

user: str

name instance-attribute 

name: str

research_description instance-attribute 

research_description: str

tasking_justification instance-attribute 

tasking_justification: str

final_decision_type instance-attribute 

final_decision_type: str

decision_details instance-attribute 

decision_details: str | None

TaskingProductRequest

Bases: BaseModel

Source code in src/csda_client/models.py 
93
94
95
96
class TaskingProductRequest(BaseModel):
    product: Product
    n_proposed_granules: int
    n_allocated_granules: int | None

product instance-attribute 

product: Product

n_proposed_granules instance-attribute 

n_proposed_granules: int

n_allocated_granules instance-attribute 

n_allocated_granules: int | None

OrderParameters

Bases: OrderParameters

Source code in src/csda_client/models.py 
 99
100
class OrderParameters(StapiOrderParameters):
    model_config = ConfigDict(extra="allow")

model_config class-attribute instance-attribute 

model_config = ConfigDict(extra='allow')