Package com.azure.resourcemanager.appplatform.models

Class ApiPortalProperties

java.lang.Object
com.azure.resourcemanager.appplatform.models.ApiPortalProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiPortalProperties>
public final class ApiPortalProperties extends Object implements com.azure.json.JsonSerializable<ApiPortalProperties>
API portal properties payload.

  • Constructor Details

    • ApiPortalProperties

      public ApiPortalProperties()
      Creates an instance of ApiPortalProperties class.

  • Method Details

    • provisioningState

      public ApiPortalProvisioningState provisioningState()
      Get the provisioningState property: State of the API portal.
      Returns:
      the provisioningState value.

    • publicProperty

      public Boolean publicProperty()
      Get the publicProperty property: Indicates whether the API portal exposes endpoint.
      Returns:
      the publicProperty value.

    • withPublicProperty

      public ApiPortalProperties withPublicProperty(Boolean publicProperty)
      Set the publicProperty property: Indicates whether the API portal exposes endpoint.
      Parameters:
      publicProperty - the publicProperty value to set.
      Returns:
      the ApiPortalProperties object itself.

    • url

      public String url()
      Get the url property: URL of the API portal, exposed when 'public' is true.
      Returns:
      the url value.

    • httpsOnly

      public Boolean httpsOnly()
      Get the httpsOnly property: Indicate if only https is allowed.
      Returns:
      the httpsOnly value.

    • withHttpsOnly

      public ApiPortalProperties withHttpsOnly(Boolean httpsOnly)
      Set the httpsOnly property: Indicate if only https is allowed.
      Parameters:
      httpsOnly - the httpsOnly value to set.
      Returns:
      the ApiPortalProperties object itself.

    • gatewayIds

      public List<String> gatewayIds()
      Get the gatewayIds property: The array of resource Ids of gateway to integrate with API portal.
      Returns:
      the gatewayIds value.

    • withGatewayIds

      public ApiPortalProperties withGatewayIds(List<String> gatewayIds)
      Set the gatewayIds property: The array of resource Ids of gateway to integrate with API portal.
      Parameters:
      gatewayIds - the gatewayIds value to set.
      Returns:
      the ApiPortalProperties object itself.

    • sourceUrls

      public List<String> sourceUrls()
      Get the sourceUrls property: Collection of OpenAPI source URL locations.
      Returns:
      the sourceUrls value.

    • withSourceUrls

      public ApiPortalProperties withSourceUrls(List<String> sourceUrls)
      Set the sourceUrls property: Collection of OpenAPI source URL locations.
      Parameters:
      sourceUrls - the sourceUrls value to set.
      Returns:
      the ApiPortalProperties object itself.

    • ssoProperties

      public SsoProperties ssoProperties()
      Get the ssoProperties property: Single sign-on related configuration.
      Returns:
      the ssoProperties value.

    • withSsoProperties

      public ApiPortalProperties withSsoProperties(SsoProperties ssoProperties)
      Set the ssoProperties property: Single sign-on related configuration.
      Parameters:
      ssoProperties - the ssoProperties value to set.
      Returns:
      the ApiPortalProperties object itself.

    • resourceRequests

      public ApiPortalResourceRequests resourceRequests()
      Get the resourceRequests property: The requested resource quantity for required CPU and Memory.
      Returns:
      the resourceRequests value.

    • instances

      public List<ApiPortalInstance> instances()
      Get the instances property: Collection of instances belong to API portal.
      Returns:
      the instances value.

    • apiTryOutEnabledState

      public ApiPortalApiTryOutEnabledState apiTryOutEnabledState()
      Get the apiTryOutEnabledState property: Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
      Returns:
      the apiTryOutEnabledState value.

    • withApiTryOutEnabledState

      public ApiPortalProperties withApiTryOutEnabledState(ApiPortalApiTryOutEnabledState apiTryOutEnabledState)
      Set the apiTryOutEnabledState property: Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.
      Parameters:
      apiTryOutEnabledState - the apiTryOutEnabledState value to set.
      Returns:
      the ApiPortalProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ApiPortalProperties>
      Throws:
      IOException

    • fromJson

      public static ApiPortalProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ApiPortalProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ApiPortalProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ApiPortalProperties.