Struct CogniteClient 

pub struct CogniteClient {

    pub api_client: Arc<ApiClient>,
    pub assets: AssetsResource,
    pub events: EventsResource,
    pub files: Files,
    pub time_series: TimeSeriesResource,
    pub groups: GroupsResource,
    pub raw: RawResource,
    pub data_sets: DataSetsResource,
    pub labels: LabelsResource,
    pub relationships: RelationshipsResource,
    pub ext_pipes: ExtPipesResource,
    pub ext_pipe_runs: ExtPipeRunsResource,
    pub sequences: SequencesResource,
    pub sessions: SessionsResource,
    pub models: Models,
}

Client object for the CDF API.

Fields

api_client: Arc<ApiClient>

Reference to an API client, which can let you make your own requests to the CDF API.

assets: AssetsResource

CDF assets resource.

events: EventsResource

CDF events resource.

files: Files

CDF files resource.

time_series: TimeSeriesResource

CDF time series resource.

groups: GroupsResource

CDF groups resource.

raw: RawResource

CDF raw resource.

data_sets: DataSetsResource

CDF data sets resource.

labels: LabelsResource

CDF labels resource.

relationships: RelationshipsResource

CDF relationships resource.

ext_pipes: ExtPipesResource

CDF extraction pipelines resource.

ext_pipe_runs: ExtPipeRunsResource

CDF extraction pipeline runs resource.

sequences: SequencesResource

CDF sequences resource.

sessions: SessionsResource

CDF sessions resource.

models: Models

CDF data modeling resource.

Implementations

impl CogniteClient

pub fn new_oidc(app_name: &str, config: Option<ClientConfig>) -> Result<Self>

Create a new cogntite client, taking OIDC credentials from the environment.

Arguments

• app_name - The value used for the x-cdp-app header.
• config - Optional configuration for retries.

This uses the environment variables

• COGNITE_BASE_URL
• COGNITE_PROJECT
• COGNITE_CLIENT_ID
• COGNITE_CLIENT_SECRET
• COGNITE_TOKEN_URL
• COGNITE_RESOURCE
• COGNITE_AUDIENCE
• COGNITE_SCOPES

pub fn new_custom_auth( api_base_url: &str, project_name: &str, auth: AuthHeaderManager, app_name: &str, config: Option<ClientConfig>, ) -> Result<Self>

Create a new cognite client, using a user-provided authentication manager.

Arguments

• api_base_url - Base URL for the API. For example https://api.cognitedata.com
• project_name - Name of the CDF project to use.
• auth - Authentication provider.
• app_name - Value used for the x-cdp-app header.
• config - Optional configuration for retries.

pub fn new_from_oidc( api_base_url: &str, auth_config: AuthenticatorConfig, project_name: &str, app_name: &str, config: Option<ClientConfig>, ) -> Result<Self>

Create a new cognite client using provided OIDC credentials.

Arguments

• api_base_url - Base URL for the API. For example https://api.cognitedata.com
• project_name - Name of the CDF project to use.
• auth_config - Configuration for creating an OIDC authenticator.
• app_name - Value used for the x-cdp-app header.
• config - Optional configuration for retries.

pub fn builder() -> Builder

Create a builder with a fluent API for creating a cognite client.

Trait Implementations

impl Clone for CogniteClient

fn clone(&self) -> CogniteClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.