Package com.azure.resourcemanager.apimanagement.fluent.models

Class ApiManagementGatewayProperties

java.lang.Object

com.azure.resourcemanager.apimanagement.models.ApiManagementGatewayBaseProperties

com.azure.resourcemanager.apimanagement.fluent.models.ApiManagementGatewayProperties

All Implemented Interfaces:

com.azure.json.JsonSerializable<ApiManagementGatewayBaseProperties>

public final class ApiManagementGatewayProperties
extends ApiManagementGatewayBaseProperties

Properties of an API Management gateway resource description.

Constructor Summary

Constructors

Constructor	Description
ApiManagementGatewayProperties()	Creates an instance of ApiManagementGatewayProperties class.

Method Summary

Modifier and Type	Method	Description
OffsetDateTime	createdAtUtc()	Get the createdAtUtc property: Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
static ApiManagementGatewayProperties	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ApiManagementGatewayProperties from the JsonReader.
String	provisioningState()	Get the provisioningState property: The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
String	targetProvisioningState()	Get the targetProvisioningState property: The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)
void	validate()	Validates the instance.
ApiManagementGatewayProperties	withBackend(BackendConfiguration backend)	Set the backend property: Information regarding how the gateway should integrate with backend systems.
ApiManagementGatewayProperties	withConfigurationApi(GatewayConfigurationApi configurationApi)	Set the configurationApi property: Information regarding the Configuration API of the API Management gateway.
ApiManagementGatewayProperties	withFrontend(FrontendConfiguration frontend)	Set the frontend property: Information regarding how the gateway should be exposed.
ApiManagementGatewayProperties	withVirtualNetworkType(VirtualNetworkType virtualNetworkType)	Set the virtualNetworkType property: The type of VPN in which API Management gateway needs to be configured in.

Methods inherited from class com.azure.resourcemanager.apimanagement.models.ApiManagementGatewayBaseProperties

backend, configurationApi, frontend, virtualNetworkType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

ApiManagementGatewayProperties

public ApiManagementGatewayProperties()

Creates an instance of ApiManagementGatewayProperties class.

Method Details

createdAtUtc

public OffsetDateTime createdAtUtc()

Get the createdAtUtc property: Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.

Overrides:

createdAtUtc in class ApiManagementGatewayBaseProperties

Returns:

the createdAtUtc value.

targetProvisioningState

public String targetProvisioningState()

Get the targetProvisioningState property: The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.

Overrides:

targetProvisioningState in class ApiManagementGatewayBaseProperties

Returns:

the targetProvisioningState value.

provisioningState

public String provisioningState()

Get the provisioningState property: The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.

Overrides:

provisioningState in class ApiManagementGatewayBaseProperties

Returns:

the provisioningState value.

withFrontend

public ApiManagementGatewayProperties withFrontend(FrontendConfiguration frontend)

Set the frontend property: Information regarding how the gateway should be exposed.

Overrides:

withFrontend in class ApiManagementGatewayBaseProperties

Parameters:

frontend - the frontend value to set.

Returns:

the ApiManagementGatewayBaseProperties object itself.

withBackend

public ApiManagementGatewayProperties withBackend(BackendConfiguration backend)

Set the backend property: Information regarding how the gateway should integrate with backend systems.

Overrides:

withBackend in class ApiManagementGatewayBaseProperties

Parameters:

backend - the backend value to set.

Returns:

the ApiManagementGatewayBaseProperties object itself.

withConfigurationApi

public ApiManagementGatewayProperties withConfigurationApi(GatewayConfigurationApi configurationApi)

Set the configurationApi property: Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.

Overrides:

withConfigurationApi in class ApiManagementGatewayBaseProperties

Parameters:

configurationApi - the configurationApi value to set.

Returns:

the ApiManagementGatewayBaseProperties object itself.

withVirtualNetworkType

public ApiManagementGatewayProperties withVirtualNetworkType(VirtualNetworkType virtualNetworkType)

Set the virtualNetworkType property: The type of VPN in which API Management gateway needs to be configured in.

Overrides:

withVirtualNetworkType in class ApiManagementGatewayBaseProperties

Parameters:

virtualNetworkType - the virtualNetworkType value to set.

Returns:

the ApiManagementGatewayBaseProperties object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class ApiManagementGatewayBaseProperties

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<ApiManagementGatewayBaseProperties>

Overrides:

toJson in class ApiManagementGatewayBaseProperties

Throws:

IOException

fromJson

public static ApiManagementGatewayProperties fromJson(com.azure.json.JsonReader jsonReader)
                                               throws IOException

Reads an instance of ApiManagementGatewayProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ApiManagementGatewayProperties 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 ApiManagementGatewayProperties.