Interface ReloadsAPI

interface ReloadsAPI {
    cancelReload: (
        reloadId: string,
        options?: ApiCallOptions,
    ) => Promise<CancelReloadHttpResponse>;
    clearCache: () => void;
    getReload: (
        reloadId: string,
        options?: ApiCallOptions,
    ) => Promise<GetReloadHttpResponse>;
    getReloads: (
        query: {
            appId: string;
            filter?: string;
            limit?: number;
            log?: boolean;
            next?: string;
            partial?: boolean;
            prev?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetReloadsHttpResponse>;
    queueReload: (
        body: ReloadRequest,
        options?: ApiCallOptions,
    ) => Promise<QueueReloadHttpResponse>;
}
Index

Properties

cancelReload clearCache getReload getReloads queueReload

Properties

cancelReload: (
    reloadId: string,
    options?: ApiCallOptions,
) => Promise<CancelReloadHttpResponse>

Cancels a reload that is in progress or has been queued

Type declaration

The unique identifier of the reload.

CancelReloadHttpError

clearCache: () => void

Clears the cache for reloads api requests.

Type declaration

    • (): void

    • Clears the cache for reloads api requests.

      Returns void

getReload: (
    reloadId: string,
    options?: ApiCallOptions,
) => Promise<GetReloadHttpResponse>

Finds and returns a reload record.

Type declaration

The unique identifier of the reload.

GetReloadHttpError

getReloads: (
    query: {
        appId: string;
        filter?: string;
        limit?: number;
        log?: boolean;
        next?: string;
        partial?: boolean;
        prev?: string;
    },
    options?: ApiCallOptions,
) => Promise<GetReloadsHttpResponse>

Finds and returns the reloads that the user has access to.

Type declaration

    • (
          query: {
              appId: string;
              filter?: string;
              limit?: number;
              log?: boolean;
              next?: string;
              partial?: boolean;
              prev?: string;
          },
          options?: ApiCallOptions,
      ): Promise<GetReloadsHttpResponse>

    • Finds and returns the reloads that the user has access to.

      Parameters

      • query: {
            appId: string;
            filter?: string;
            limit?: number;
            log?: boolean;
            next?: string;
            partial?: boolean;
            prev?: string;
        }

        an object with query parameters

        • appId: string

          The UUID formatted string used to search for an app's reload history entries. TenantAdmin users may omit this parameter to list all reload history in the tenant.

        • Optionalfilter?: string

          SCIM filter expression used to search for reloads. The filter syntax is defined in RFC 7644 section 3.4.2.2

          Supported attributes:

          • status: see #schemas/Status
          • partial: see #schemas/Partial
          • type: see #schemas/Type

          Supported operators:

          • eq
        • Optionallimit?: number

          The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

        • Optionallog?: boolean

          The boolean value used to include the log field or not, set log=true to include the log field.

        • Optionalnext?: string

          The cursor to the next page of resources. Provide either the next or prev cursor, but not both.

        • Optionalpartial?: boolean

          The boolean value used to search for a reload is partial or not.

        • Optionalprev?: string

          The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetReloadsHttpResponse>

      getReloads(
        {
          filter: "(status eq \"FAILED\" or status eq \"EXCEEDED_LIMIT\") and partial eq \"false\" and type eq \"chronos\"
          "
        }
      )

      GetReloadsHttpError

getReloads(
  {
    filter: "(status eq \"FAILED\" or status eq \"EXCEEDED_LIMIT\") and partial eq \"false\" and type eq \"chronos\"
    "
  }
)

an object with query parameters

GetReloadsHttpError

queueReload: (
    body: ReloadRequest,
    options?: ApiCallOptions,
) => Promise<QueueReloadHttpResponse>

Reloads an app specified by an app ID.

Type declaration

Param: body

an object with the body content

QueueReloadHttpError

Settings

Member Visibility

On This Page

Properties