Skip to content

Latest commit

 

History

History
724 lines (537 loc) · 67.8 KB

File metadata and controls

724 lines (537 loc) · 67.8 KB

LogStream

Overview

Available Operations

createLogStreamProjectsProjectIdLogStreamsPost

Create a new log stream for a project.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.logStream.createLogStreamProjectsProjectIdLogStreamsPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {
      name: "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { logStreamCreateLogStreamProjectsProjectIdLogStreamsPost } from "galileo-generated/funcs/logStreamCreateLogStreamProjectsProjectIdLogStreamsPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamCreateLogStreamProjectsProjectIdLogStreamsPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {
      name: "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("logStreamCreateLogStreamProjectsProjectIdLogStreamsPost failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.CreateLogStreamProjectsProjectIdLogStreamsPostRequest ✔️ The request object to use for the request.
security operations.CreateLogStreamProjectsProjectIdLogStreamsPostSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.LogStreamResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

listLogStreamsProjectsProjectIdLogStreamsGet

Retrieve all log streams for a project.

DEPRECATED in favor of list_log_streams_paginated.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.logStream.listLogStreamsProjectsProjectIdLogStreamsGet({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { logStreamListLogStreamsProjectsProjectIdLogStreamsGet } from "galileo-generated/funcs/logStreamListLogStreamsProjectsProjectIdLogStreamsGet.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamListLogStreamsProjectsProjectIdLogStreamsGet(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("logStreamListLogStreamsProjectsProjectIdLogStreamsGet failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.ListLogStreamsProjectsProjectIdLogStreamsGetRequest ✔️ The request object to use for the request.
security operations.ListLogStreamsProjectsProjectIdLogStreamsGetSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.LogStreamResponse[]>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

listLogStreamsPaginatedProjectsProjectIdLogStreamsPaginatedGet

Retrieve all log streams for a project paginated.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.logStream.listLogStreamsPaginatedProjectsProjectIdLogStreamsPaginatedGet({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { logStreamListLogStreamsPaginatedProjectsProjectIdLogStreamsPaginatedGet } from "galileo-generated/funcs/logStreamListLogStreamsPaginatedProjectsProjectIdLogStreamsPaginatedGet.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamListLogStreamsPaginatedProjectsProjectIdLogStreamsPaginatedGet(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("logStreamListLogStreamsPaginatedProjectsProjectIdLogStreamsPaginatedGet failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.ListLogStreamsPaginatedProjectsProjectIdLogStreamsPaginatedGetRequest ✔️ The request object to use for the request.
security operations.ListLogStreamsPaginatedProjectsProjectIdLogStreamsPaginatedGetSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ListLogStreamResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

searchLogStreamsProjectsProjectIdLogStreamsSearchPost

Search log streams for a project.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.logStream.searchLogStreamsProjectsProjectIdLogStreamsSearchPost({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {},
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { logStreamSearchLogStreamsProjectsProjectIdLogStreamsSearchPost } from "galileo-generated/funcs/logStreamSearchLogStreamsProjectsProjectIdLogStreamsSearchPost.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamSearchLogStreamsProjectsProjectIdLogStreamsSearchPost(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    body: {},
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("logStreamSearchLogStreamsProjectsProjectIdLogStreamsSearchPost failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.SearchLogStreamsProjectsProjectIdLogStreamsSearchPostRequest ✔️ The request object to use for the request.
security operations.SearchLogStreamsProjectsProjectIdLogStreamsSearchPostSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.ListLogStreamResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

getLogStreamProjectsProjectIdLogStreamsLogStreamIdGet

Retrieve a specific log stream.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.logStream.getLogStreamProjectsProjectIdLogStreamsLogStreamIdGet({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    logStreamId: "<value>",
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { logStreamGetLogStreamProjectsProjectIdLogStreamsLogStreamIdGet } from "galileo-generated/funcs/logStreamGetLogStreamProjectsProjectIdLogStreamsLogStreamIdGet.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamGetLogStreamProjectsProjectIdLogStreamsLogStreamIdGet(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    logStreamId: "<value>",
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("logStreamGetLogStreamProjectsProjectIdLogStreamsLogStreamIdGet failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.GetLogStreamProjectsProjectIdLogStreamsLogStreamIdGetRequest ✔️ The request object to use for the request.
security operations.GetLogStreamProjectsProjectIdLogStreamsLogStreamIdGetSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.LogStreamResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

updateLogStreamProjectsProjectIdLogStreamsLogStreamIdPut

Update a specific log stream.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.logStream.updateLogStreamProjectsProjectIdLogStreamsLogStreamIdPut({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    logStreamId: "<value>",
    projectId: "<value>",
    body: {
      name: "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { logStreamUpdateLogStreamProjectsProjectIdLogStreamsLogStreamIdPut } from "galileo-generated/funcs/logStreamUpdateLogStreamProjectsProjectIdLogStreamsLogStreamIdPut.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamUpdateLogStreamProjectsProjectIdLogStreamsLogStreamIdPut(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    logStreamId: "<value>",
    projectId: "<value>",
    body: {
      name: "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("logStreamUpdateLogStreamProjectsProjectIdLogStreamsLogStreamIdPut failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateLogStreamProjectsProjectIdLogStreamsLogStreamIdPutRequest ✔️ The request object to use for the request.
security operations.UpdateLogStreamProjectsProjectIdLogStreamsLogStreamIdPutSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.LogStreamResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

deleteLogStreamProjectsProjectIdLogStreamsLogStreamIdDelete

Delete a specific log stream.

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  await galileoGenerated.logStream.deleteLogStreamProjectsProjectIdLogStreamsLogStreamIdDelete({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    logStreamId: "<value>",
    projectId: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import { logStreamDeleteLogStreamProjectsProjectIdLogStreamsLogStreamIdDelete } from "galileo-generated/funcs/logStreamDeleteLogStreamProjectsProjectIdLogStreamsLogStreamIdDelete.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamDeleteLogStreamProjectsProjectIdLogStreamsLogStreamIdDelete(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    logStreamId: "<value>",
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    
  } else {
    console.log("logStreamDeleteLogStreamProjectsProjectIdLogStreamsLogStreamIdDelete failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteLogStreamProjectsProjectIdLogStreamsLogStreamIdDeleteRequest ✔️ The request object to use for the request.
security operations.DeleteLogStreamProjectsProjectIdLogStreamsLogStreamIdDeleteSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

updateMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsPatch

Update Metric Settings

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.logStream.updateMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsPatch({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    logStreamId: "<value>",
    body: {},
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import {
  logStreamUpdateMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsPatch,
} from "galileo-generated/funcs/logStreamUpdateMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsPatch.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamUpdateMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsPatch(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    projectId: "<value>",
    logStreamId: "<value>",
    body: {},
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("logStreamUpdateMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsPatch failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsPatchRequest ✔️ The request object to use for the request.
security operations.UpdateMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsPatchSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.MetricSettingsResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*

getMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsGet

Get Metric Settings

Example Usage

import { GalileoGenerated } from "galileo-generated";

const galileoGenerated = new GalileoGenerated();

async function run() {
  const result = await galileoGenerated.logStream.getMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsGet({
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    logStreamId: "<value>",
    projectId: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { GalileoGeneratedCore } from "galileo-generated/core.js";
import {
  logStreamGetMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsGet,
} from "galileo-generated/funcs/logStreamGetMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsGet.js";

// Use `GalileoGeneratedCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const galileoGenerated = new GalileoGeneratedCore();

async function run() {
  const res = await logStreamGetMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsGet(galileoGenerated, {
    apiKeyHeader: process.env["GALILEOGENERATED_API_KEY_HEADER"] ?? "",
  }, {
    logStreamId: "<value>",
    projectId: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("logStreamGetMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsGet failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.GetMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsGetRequest ✔️ The request object to use for the request.
security operations.GetMetricSettingsProjectsProjectIdLogStreamsLogStreamIdMetricSettingsGetSecurity ✔️ The security requirements to use for the request.
options RequestOptions Used to set various options for making HTTP requests.
options.fetchOptions RequestInit Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig Enables retrying HTTP requests under certain failure conditions.

Response

Promise<models.MetricSettingsResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.GalileoGeneratedDefaultError 4XX, 5XX */*