Cluster Creator Kit Script Reference
    Preparing search index...

    Interface ClusterScriptError

    An exception that will occur when a non-permitted operation is attempted. Any API may throw this exception.

    Permission to perform an operation may dynamically change based on various factors, such as beta permission status, distance, processing load in the space, user status, etc.

    Depending on the type of the permission missing, the exception's corresponding boolean fields will be set to true.

    If multiple permissions were missing, multiple fields may be set to true simultaneously.

    interface ClusterScriptError {
        distanceLimitExceeded: boolean;
        executionNotAllowed: boolean;
        message: string;
        name: string;
        rateLimitExceeded: boolean;
        requestSizeLimitExceeded: boolean;
        stack?: string;
    }

    Hierarchy

    • Error
      • ClusterScriptError
    Index

    Properties

    distanceLimitExceeded executionNotAllowed message name rateLimitExceeded requestSizeLimitExceeded stack?

    Properties

    distanceLimitExceeded: boolean

    This field remains for backward compatibility and will always be false.

    executionNotAllowed: boolean

    If the operation was refused due to the operation not being allowed, this will be true.

    An example of this is when a beta-only API was called in an environment that didn't have access to beta features.

    message: string

    The error message.

    name: string
    rateLimitExceeded: boolean

    If the operation was refused due to rate limitations, this will be true.

    requestSizeLimitExceeded: boolean

    If the operation was refused due to request size limitations, this will be true.

    stack?: string

    Settings

    Member Visibility

    On This Page

    Properties