Skip to main content

modifyApplication

This mutation selects an Application by its ID or unique name and modifies it to have the given unique name, description, Propeller, and scopes.

If any of the optional arguments are omitted, those properties will be unchanged on the Application.

An Application is an OAuth 2.0 client that gives you scoped access to the Propel APIs; a Propeller significantly increases the query performance of a Metric; and scopes securely specify the permissions allowed to the Application.

Arguments

  • input required modifyApplicationInput

    The fields for modifying an Application.

    • input.idOrUniqueName required idOrUniqueName

      The ID or unique name of the Application to modify.

      The ID or unique name input.

      If both ID and unique name are provided, the ID will take precedence.

    • input.uniqueName optional String

      The Application's new unique name.

    • input.description optional String

      The Application's new description.

    • input.propeller optional Propeller

      The Application's new Propeller.

      A Propeller defines the compute power assigned to a Propel Application. The larger its compute power, the faster the queries. With Propellers, you can assign different compute powers (and cost profiles) to different use cases or workloads (with the same data).

      Propellers have the following properties:

      Max RPS: The maximum number of records per second (RPS) that can be processed by the Propeller on a single query.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • input.scopes optional array of ApplicationScope

      The Application's new API authorization scopes.

      The API operations an Application is authorized to perform.

      • ADMIN

        Grant read/write access to Data Sources, Data Pools and Metrics.

      • METRIC_QUERY

        Grant read access to query Metrics.

      • METRIC_STATS

        Grant read access to fetch Dimension statistics from Metrics.


Returns

Nullable ApplicationOrFailureResponse

The result of a mutation which creates or modifies an Application.

If successful, an ApplicationResponse will be returned; otherwise, a FailureResponse will be returned.