GatewayProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.appplatform.models.GatewayProperties

Implements

public final class GatewayProperties
implements JsonSerializable<GatewayProperties>

Spring Cloud Gateway properties payload.

Constructor Summary

Constructor Description
GatewayProperties()

Creates an instance of GatewayProperties class.

Method Summary

Modifier and Type Method and Description
GatewayApiMetadataProperties apiMetadataProperties()

Get the apiMetadataProperties property: API metadata property for Spring Cloud Gateway.

List<ApmReference> apms()

Get the apms property: Collection of ApmReferences in service level.

GatewayPropertiesClientAuth clientAuth()

Get the clientAuth property: Client-Certification Authentication.

GatewayCorsProperties corsProperties()

Get the corsProperties property: Cross-Origin Resource Sharing property.

GatewayPropertiesEnvironmentVariables environmentVariables()

Get the environmentVariables property: Environment variables of Spring Cloud Gateway.

static GatewayProperties fromJson(JsonReader jsonReader)

Reads an instance of GatewayProperties from the JsonReader.

Boolean httpsOnly()

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

List<GatewayInstance> instances()

Get the instances property: Collection of instances belong to Spring Cloud Gateway.

GatewayOperatorProperties operatorProperties()

Get the operatorProperties property: Properties of the Spring Cloud Gateway Operator.

GatewayProvisioningState provisioningState()

Get the provisioningState property: State of the Spring Cloud Gateway.

Boolean publicProperty()

Get the publicProperty property: Indicates whether the Spring Cloud Gateway exposes endpoint.

GatewayResourceRequests resourceRequests()

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

SsoProperties ssoProperties()

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

JsonWriter toJson(JsonWriter jsonWriter)
String url()

Get the url property: URL of the Spring Cloud Gateway, exposed when 'public' is true.

void validate()

Validates the instance.

GatewayProperties withApiMetadataProperties(GatewayApiMetadataProperties apiMetadataProperties)

Set the apiMetadataProperties property: API metadata property for Spring Cloud Gateway.

GatewayProperties withApms(List<ApmReference> apms)

Set the apms property: Collection of ApmReferences in service level.

GatewayProperties withClientAuth(GatewayPropertiesClientAuth clientAuth)

Set the clientAuth property: Client-Certification Authentication.

GatewayProperties withCorsProperties(GatewayCorsProperties corsProperties)

Set the corsProperties property: Cross-Origin Resource Sharing property.

GatewayProperties withEnvironmentVariables(GatewayPropertiesEnvironmentVariables environmentVariables)

Set the environmentVariables property: Environment variables of Spring Cloud Gateway.

GatewayProperties withHttpsOnly(Boolean httpsOnly)

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

GatewayProperties withPublicProperty(Boolean publicProperty)

Set the publicProperty property: Indicates whether the Spring Cloud Gateway exposes endpoint.

GatewayProperties withResourceRequests(GatewayResourceRequests resourceRequests)

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

GatewayProperties withSsoProperties(SsoProperties ssoProperties)

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

Methods inherited from java.lang.Object

Constructor Details

GatewayProperties

public GatewayProperties()

Creates an instance of GatewayProperties class.

Method Details

apiMetadataProperties

public GatewayApiMetadataProperties apiMetadataProperties()

Get the apiMetadataProperties property: API metadata property for Spring Cloud Gateway.

Returns:

the apiMetadataProperties value.

apms

public List apms()

Get the apms property: Collection of ApmReferences in service level.

Returns:

the apms value.

clientAuth

public GatewayPropertiesClientAuth clientAuth()

Get the clientAuth property: Client-Certification Authentication.

Returns:

the clientAuth value.

corsProperties

public GatewayCorsProperties corsProperties()

Get the corsProperties property: Cross-Origin Resource Sharing property.

Returns:

the corsProperties value.

environmentVariables

public GatewayPropertiesEnvironmentVariables environmentVariables()

Get the environmentVariables property: Environment variables of Spring Cloud Gateway.

Returns:

the environmentVariables value.

fromJson

public static GatewayProperties fromJson(JsonReader jsonReader)

Reads an instance of GatewayProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

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 Spring Cloud Gateway.

Returns:

the instances value.

operatorProperties

public GatewayOperatorProperties operatorProperties()

Get the operatorProperties property: Properties of the Spring Cloud Gateway Operator.

Returns:

the operatorProperties value.

provisioningState

public GatewayProvisioningState provisioningState()

Get the provisioningState property: State of the Spring Cloud Gateway.

Returns:

the provisioningState value.

publicProperty

public Boolean publicProperty()

Get the publicProperty property: Indicates whether the Spring Cloud Gateway exposes endpoint.

Returns:

the publicProperty value.

resourceRequests

public GatewayResourceRequests resourceRequests()

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

Returns:

the resourceRequests 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 Spring Cloud Gateway, exposed when 'public' is true.

Returns:

the url value.

validate

public void validate()

Validates the instance.

withApiMetadataProperties

public GatewayProperties withApiMetadataProperties(GatewayApiMetadataProperties apiMetadataProperties)

Set the apiMetadataProperties property: API metadata property for Spring Cloud Gateway.

Parameters:

apiMetadataProperties - the apiMetadataProperties value to set.

Returns:

the GatewayProperties object itself.

withApms

public GatewayProperties withApms(List apms)

Set the apms property: Collection of ApmReferences in service level.

Parameters:

apms - the apms value to set.

Returns:

the GatewayProperties object itself.

withClientAuth

public GatewayProperties withClientAuth(GatewayPropertiesClientAuth clientAuth)

Set the clientAuth property: Client-Certification Authentication.

Parameters:

clientAuth - the clientAuth value to set.

Returns:

the GatewayProperties object itself.

withCorsProperties

public GatewayProperties withCorsProperties(GatewayCorsProperties corsProperties)

Set the corsProperties property: Cross-Origin Resource Sharing property.

Parameters:

corsProperties - the corsProperties value to set.

Returns:

the GatewayProperties object itself.

withEnvironmentVariables

public GatewayProperties withEnvironmentVariables(GatewayPropertiesEnvironmentVariables environmentVariables)

Set the environmentVariables property: Environment variables of Spring Cloud Gateway.

Parameters:

environmentVariables - the environmentVariables value to set.

Returns:

the GatewayProperties object itself.

withHttpsOnly

public GatewayProperties withHttpsOnly(Boolean httpsOnly)

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

Parameters:

httpsOnly - the httpsOnly value to set.

Returns:

the GatewayProperties object itself.

withPublicProperty

public GatewayProperties withPublicProperty(Boolean publicProperty)

Set the publicProperty property: Indicates whether the Spring Cloud Gateway exposes endpoint.

Parameters:

publicProperty - the publicProperty value to set.

Returns:

the GatewayProperties object itself.

withResourceRequests

public GatewayProperties withResourceRequests(GatewayResourceRequests resourceRequests)

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

Parameters:

resourceRequests - the resourceRequests value to set.

Returns:

the GatewayProperties object itself.

withSsoProperties

public GatewayProperties withSsoProperties(SsoProperties ssoProperties)

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

Parameters:

ssoProperties - the ssoProperties value to set.

Returns:

the GatewayProperties object itself.

Applies to