Package com.azure.resourcemanager.apimanagement.models

Interface ProductContract

  • public interface ProductContract
    An immutable client-side representation of ProductContract.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • displayName

        String displayName()
        Gets the displayName property: Product name.
        Returns:
        the displayName value.

      • description

        String description()
        Gets the description property: Product description. May include HTML formatting tags.
        Returns:
        the description value.

      • terms

        String terms()
        Gets the terms property: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
        Returns:
        the terms value.

      • subscriptionRequired

        Boolean subscriptionRequired()
        Gets the subscriptionRequired property: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
        Returns:
        the subscriptionRequired value.

      • approvalRequired

        Boolean approvalRequired()
        Gets the approvalRequired property: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
        Returns:
        the approvalRequired value.

      • subscriptionsLimit

        Integer subscriptionsLimit()
        Gets the subscriptionsLimit property: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
        Returns:
        the subscriptionsLimit value.

      • state

        ProductState state()
        Gets the state property: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
        Returns:
        the state value.

      • innerModel

        ProductContractInner innerModel()
        Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.ProductContractInner object.
        Returns:
        the inner object.

      • update

        ProductContract.Update update()
        Begins update for the ProductContract resource.
        Returns:
        the stage of resource update.

      • refresh

        ProductContract refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        ProductContract refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.