Share via

ApiPortalProperties Class

  • Reference
Package:
com.azure.resourcemanager.appplatform.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-appplatform:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.appplatform.models.ApiPortalProperties

Implements

JsonSerializable<ApiPortalProperties>

public final class ApiPortalProperties
implements JsonSerializable<ApiPortalProperties>

API portal properties payload.

Constructor Summary

Constructor Description
ApiPortalProperties()

Creates an instance of ApiPortalProperties class.

Method Summary

Modifier and Type Method and Description
ApiPortalApiTryOutEnabledState apiTryOutEnabledState()

Get the apiTryOutEnabledState property: Indicates whether the API try-out feature is enabled or disabled.
static ApiPortalProperties fromJson(JsonReader jsonReader)

Reads an instance of ApiPortalProperties from the JsonReader.
List<String> gatewayIds()

Get the gatewayIds property: The array of resource Ids of gateway to integrate with API portal.
Boolean httpsOnly()

Get the httpsOnly property: Indicate if only https is allowed.
List<ApiPortalInstance> instances()

Get the instances property: Collection of instances belong to API portal.
ApiPortalProvisioningState provisioningState()

Get the provisioningState property: State of the API portal.
Boolean publicProperty()

Get the publicProperty property: Indicates whether the API portal exposes endpoint.
ApiPortalResourceRequests resourceRequests()

Get the resourceRequests property: The requested resource quantity for required CPU and Memory.
List<String> sourceUrls()

Get the sourceUrls property: Collection of OpenAPI source URL locations.
SsoProperties ssoProperties()

Get the ssoProperties property: Single sign-on related configuration.
JsonWriter toJson(JsonWriter jsonWriter)
String url()

Get the url property: URL of the API portal, exposed when 'public' is true.
void validate()

Validates the instance.
ApiPortalProperties withApiTryOutEnabledState(ApiPortalApiTryOutEnabledState apiTryOutEnabledState)

Set the apiTryOutEnabledState property: Indicates whether the API try-out feature is enabled or disabled.
ApiPortalProperties withGatewayIds(List<String> gatewayIds)

Set the gatewayIds property: The array of resource Ids of gateway to integrate with API portal.
ApiPortalProperties withHttpsOnly(Boolean httpsOnly)

Set the httpsOnly property: Indicate if only https is allowed.
ApiPortalProperties withPublicProperty(Boolean publicProperty)

Set the publicProperty property: Indicates whether the API portal exposes endpoint.
ApiPortalProperties withSourceUrls(List<String> sourceUrls)

Set the sourceUrls property: Collection of OpenAPI source URL locations.
ApiPortalProperties withSsoProperties(SsoProperties ssoProperties)

Set the ssoProperties property: Single sign-on related configuration.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ApiPortalProperties

public ApiPortalProperties()

Creates an instance of ApiPortalProperties class.

Method Details

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.

fromJson

public static ApiPortalProperties fromJson(JsonReader jsonReader)

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.

gatewayIds

public List gatewayIds()

Get the gatewayIds property: The array of resource Ids of gateway to integrate with API portal.

Returns:

the gatewayIds value.

httpsOnly

public Boolean httpsOnly()

Get the httpsOnly property: Indicate if only https is allowed.

Returns:

the httpsOnly value.

instances

public List instances()

Get the instances property: Collection of instances belong to API portal.

Returns:

the instances value.

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.

resourceRequests

public ApiPortalResourceRequests resourceRequests()

Get the resourceRequests property: The requested resource quantity for required CPU and Memory.

Returns:

the resourceRequests value.

sourceUrls

public List sourceUrls()

Get the sourceUrls property: Collection of OpenAPI source URL locations.

Returns:

the sourceUrls value.

ssoProperties

public SsoProperties ssoProperties()

Get the ssoProperties property: Single sign-on related configuration.

Returns:

the ssoProperties value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

url

public String url()

Get the url property: URL of the API portal, exposed when 'public' is true.

Returns:

the url value.

validate

public void validate()

Validates the instance.

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.

withGatewayIds

public ApiPortalProperties withGatewayIds(List 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.

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.

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.

withSourceUrls

public ApiPortalProperties withSourceUrls(List sourceUrls)

Set the sourceUrls property: Collection of OpenAPI source URL locations.

Parameters:

sourceUrls - the sourceUrls value to set.

Returns:

the ApiPortalProperties object itself.

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.

Applies to