Available Queries

The gpp_client.api.custom_queries module defines statically typed query builders corresponding to GraphQL Query operations available in the GPP schema.

Each function or class in this module allows you to construct a well-formed GraphQL query by supplying the required arguments and selecting specific fields to return. These builders ensure correctness, help avoid typos, and provide autocomplete support when working in an IDE.

Query builders are typically used with .fields(...) to define the selection set:

from gpp_client.api.custom_queries import Query
from gpp_client.api.custom_fields import ProgramFields

query = Query.program(program_id="p-test").fields(
    ProgramFields.id,
    ProgramFields.name,
)

These builders are passed directly to client.query(...):

result = await client.query(query, operation_name="program")

API Reference

class gpp_client.api.custom_queries.Query

Bases: object

classmethod asterism_group(include_deleted: bool, *, program_id: Any | None = None, proposal_reference: Any | None = None, program_reference: Any | None = None, where: WhereObservation | None = None, limit: Any | None = None) → AsterismGroupSelectResultFields

Observations grouped by commonly held science asterisms. Identify the program by specifying only one of programId, programReference, or proposalReference. If more than one is provided, all must match. If none are set, nothing will match.

classmethod call_for_proposals(call_for_proposals_id: Any) → CallForProposalsFields

Select a single Call for Proposals by id.

classmethod calls_for_proposals(include_deleted: bool, *, where: WhereCallForProposals | None = None, offset: Any | None = None, limit: Any | None = None) → CallsForProposalsSelectResultFields

Select all Calls for Proposals.

classmethod configuration_requests(*, where: WhereConfigurationRequest | None = None, offset: Any | None = None, limit: Any | None = None) → ConfigurationRequestSelectResultFields

Selects the first LIMIT matching configuration requests based on the provided WHERE parameter, if any.

classmethod constraint_set_group(include_deleted: bool, *, program_id: Any | None = None, proposal_reference: Any | None = None, program_reference: Any | None = None, where: WhereObservation | None = None, limit: Any | None = None) → ConstraintSetGroupSelectResultFields

Observations grouped by commonly held constraints. Identify the program by specifying only one of programId, programReference, or proposalReference. If more than one is provided, all must match. If none are set, nothing will match.

classmethod dataset(*, dataset_id: Any | None = None, dataset_reference: Any | None = None) → DatasetFields

Returns the dataset with the given id or reference, if any. Identify the dataset by specifying only one of datasetId or datasetReference. If more than one is provided, all must match. If neither are set, nothing will match.

classmethod dataset_chronicle_entries(*, where: WhereDatasetChronicleEntry | None = None, offset: Any | None = None, limit: Any | None = None) → DatasetChronicleEntrySelectResultFields

Select all dataset chronicle entries. This will contain detailed information about dataset creation and updates.

classmethod datasets(*, where: WhereDataset | None = None, offset: Any | None = None, limit: Any | None = None) → DatasetSelectResultFields

Select all datasets associated with a step or observation

classmethod events(*, where: WhereExecutionEvent | None = None, offset: Any | None = None, limit: Any | None = None) → ExecutionEventSelectResultFields

Selects the first LIMIT matching execution events based on the provided WHERE parameter, if any.

classmethod execution_config(*, observation_id: Any | None = None, observation_reference: Any | None = None, future_limit: Any | None = None) → ExecutionConfigFields

Full execution config, including static values and acquisition and science sequences. If a sequence cannot be generated for this observation, null is returned along with warning messages.

classmethod filter_type_meta() → FilterTypeMetaFields

Metadata for enum FilterType

classmethod goa_data_download_access(orcid_id: str) → GraphQLField

Obtains a list of program references for which the user with ORCiD orcidId has GOA data-download access privileges. These will be those for which the user is a ProgramUser of any role with the hasDataAccess flag set.

This query is for use by staff and the GOA and will fail for other users.

classmethod group(group_id: Any) → GroupFields

Returns the group indicated by the given groupId, if found.

classmethod imaging_config_options(*, where: WhereImagingConfigOption | None = None) → ImagingConfigOptionFields

Imaging configuration options matching the WHERE parameter.

classmethod observation(*, observation_id: Any | None = None, observation_reference: Any | None = None) → ObservationFields

Returns the observation with the given id or reference, if any. Identify the observation by specifying only one of observationId or observationReference. If more than one is provided, all must match. If neither are set, nothing will match.

classmethod observations(include_deleted: bool, *, where: WhereObservation | None = None, offset: Any | None = None, limit: Any | None = None) → ObservationSelectResultFields

Selects the first LIMIT matching observations based on the provided WHERE parameter, if any.

classmethod observing_mode_group(include_deleted: bool, *, program_id: Any | None = None, proposal_reference: Any | None = None, program_reference: Any | None = None, where: WhereObservation | None = None, limit: Any | None = None) → ObservingModeGroupSelectResultFields

Observations grouped by commonly held observing modes. Identify the program by specifying only one of programId, programReference, or proposalReference. If more than one is provided, all must match. If none are set, nothing will match.

classmethod program(*, program_id: Any | None = None, proposal_reference: Any | None = None, program_reference: Any | None = None) → ProgramFields

Returns the program with the given id or reference, if any. Identify the program by specifying only one of programId, programReference, or proposalReference. If more than one is provided, all must match. If none are set, nothing will match.

classmethod program_note(program_note_id: Any) → ProgramNoteFields

Selects the program note with the given id, if any.

classmethod program_notes(include_deleted: bool, *, where: WhereProgramNote | None = None, offset: Any | None = None, limit: Any | None = None) → ProgramNoteSelectResultFields

Selects the first LIMIT matching program notes based on the provided WHERE parameter, if any.

classmethod program_users(include_deleted: bool, *, where: WhereProgramUser | None = None, offset: Any | None = None, limit: Any | None = None) → ProgramUserSelectResultFields

Selects the first LIMIT matching program users based on the provided WHERE parameter, if any.

classmethod programs(include_deleted: bool, *, where: WhereProgram | None = None, offset: Any | None = None, limit: Any | None = None) → ProgramSelectResultFields

Selects the first LIMIT matching programs based on the provided WHERE parameter, if any.

classmethod proposal_status_meta() → ProposalStatusMetaFields

Metadata for `enum ProposalStatus

classmethod spectroscopy_config_options(*, where: WhereSpectroscopyConfigOption | None = None) → SpectroscopyConfigOptionFields

Spectroscopy configuration options matching the WHERE parameter.

classmethod target(target_id: Any) → TargetFields

Retrieves the target with the given id, if it exists

classmethod target_group(include_deleted: bool, *, program_id: Any | None = None, proposal_reference: Any | None = None, program_reference: Any | None = None, where: WhereObservation | None = None, limit: Any | None = None) → TargetGroupSelectResultFields

Observations grouped by commonly held targets. Identify the program by specifying only one of programId, programReference, or proposalReference. If more than one is provided, all must match. If none are set, nothing will match.

classmethod targets(include_deleted: bool, *, where: WhereTarget | None = None, offset: Any | None = None, limit: Any | None = None) → TargetSelectResultFields

Selects the first LIMIT matching targets based on the provided WHERE parameter, if any.