azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.a...

256 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties"
name: "GatewayRouteConfigProperties"
nameWithType: "GatewayRouteConfigProperties"
summary: "API route config of the Spring Cloud Gateway."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **GatewayRouteConfigProperties**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.GatewayRouteConfigProperties()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.GatewayRouteConfigProperties()"
name: "GatewayRouteConfigProperties()"
nameWithType: "GatewayRouteConfigProperties.GatewayRouteConfigProperties()"
summary: "Creates an instance of Gateway<wbr>Route<wbr>Config<wbr>Properties class."
syntax: "public GatewayRouteConfigProperties()"
desc: "Creates an instance of GatewayRouteConfigProperties class."
methods:
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.appResourceId()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.appResourceId()"
name: "appResourceId()"
nameWithType: "GatewayRouteConfigProperties.appResourceId()"
summary: "Get the app<wbr>Resource<wbr>Id property: The resource Id of the Azure Spring Apps app, required unless route defines \\`uri\\`."
syntax: "public String appResourceId()"
desc: "Get the appResourceId property: The resource Id of the Azure Spring Apps app, required unless route defines \\`uri\\`."
returns:
description: "the appResourceId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.filters()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.filters()"
name: "filters()"
nameWithType: "GatewayRouteConfigProperties.filters()"
summary: "Get the filters property: To modify the request before sending it to the target endpoint, or the received response in app level."
syntax: "public List<String> filters()"
desc: "Get the filters property: To modify the request before sending it to the target endpoint, or the received response in app level."
returns:
description: "the filters value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "GatewayRouteConfigProperties.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Gateway<wbr>Route<wbr>Config<wbr>Properties from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static GatewayRouteConfigProperties fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the GatewayRouteConfigProperties."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of GatewayRouteConfigProperties from the JsonReader."
returns:
description: "An instance of GatewayRouteConfigProperties if the JsonReader was pointing to an instance of it, or null\n if it was pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.openApi()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.openApi()"
name: "openApi()"
nameWithType: "GatewayRouteConfigProperties.openApi()"
summary: "Get the open<wbr>Api property: OpenAPI properties of Spring Cloud Gateway route config."
syntax: "public GatewayRouteConfigOpenApiProperties openApi()"
desc: "Get the openApi property: OpenAPI properties of Spring Cloud Gateway route config."
returns:
description: "the openApi value."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigOpenApiProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigOpenApiProperties&text=GatewayRouteConfigOpenApiProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.predicates()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.predicates()"
name: "predicates()"
nameWithType: "GatewayRouteConfigProperties.predicates()"
summary: "Get the predicates property: A number of conditions to evaluate a route for each request in app level."
syntax: "public List<String> predicates()"
desc: "Get the predicates property: A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request."
returns:
description: "the predicates value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.protocol()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.protocol()"
name: "protocol()"
nameWithType: "GatewayRouteConfigProperties.protocol()"
summary: "Get the protocol property: Protocol of routed Azure Spring Apps applications."
syntax: "public GatewayRouteConfigProtocol protocol()"
desc: "Get the protocol property: Protocol of routed Azure Spring Apps applications."
returns:
description: "the protocol value."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProtocol?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProtocol&text=GatewayRouteConfigProtocol\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.provisioningState()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.provisioningState()"
name: "provisioningState()"
nameWithType: "GatewayRouteConfigProperties.provisioningState()"
summary: "Get the provisioning<wbr>State property: State of the Spring Cloud Gateway route config."
syntax: "public GatewayProvisioningState provisioningState()"
desc: "Get the provisioningState property: State of the Spring Cloud Gateway route config."
returns:
description: "the provisioningState value."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayProvisioningState?alt=com.azure.resourcemanager.appplatform.models.GatewayProvisioningState&text=GatewayProvisioningState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.routes()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.routes()"
name: "routes()"
nameWithType: "GatewayRouteConfigProperties.routes()"
summary: "Get the routes property: Array of API routes, each route contains properties such as \\`title\\`, \\`uri\\`, \\`sso<wbr>Enabled\\`, \\`predicates\\`, \\`filters\\`."
syntax: "public List<GatewayApiRoute> routes()"
desc: "Get the routes property: Array of API routes, each route contains properties such as \\`title\\`, \\`uri\\`, \\`ssoEnabled\\`, \\`predicates\\`, \\`filters\\`."
returns:
description: "the routes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayApiRoute?alt=com.azure.resourcemanager.appplatform.models.GatewayApiRoute&text=GatewayApiRoute\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.ssoEnabled()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.ssoEnabled()"
name: "ssoEnabled()"
nameWithType: "GatewayRouteConfigProperties.ssoEnabled()"
summary: "Get the sso<wbr>Enabled property: Enable Single Sign-On in app level."
syntax: "public Boolean ssoEnabled()"
desc: "Get the ssoEnabled property: Enable Single Sign-On in app level."
returns:
description: "the ssoEnabled value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "GatewayRouteConfigProperties.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.validate()"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.validate()"
name: "validate()"
nameWithType: "GatewayRouteConfigProperties.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withAppResourceId(java.lang.String)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withAppResourceId(String appResourceId)"
name: "withAppResourceId(String appResourceId)"
nameWithType: "GatewayRouteConfigProperties.withAppResourceId(String appResourceId)"
summary: "Set the app<wbr>Resource<wbr>Id property: The resource Id of the Azure Spring Apps app, required unless route defines \\`uri\\`."
parameters:
- description: "the appResourceId value to set."
name: "appResourceId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public GatewayRouteConfigProperties withAppResourceId(String appResourceId)"
desc: "Set the appResourceId property: The resource Id of the Azure Spring Apps app, required unless route defines \\`uri\\`."
returns:
description: "the GatewayRouteConfigProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withFilters(java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withFilters(List<String> filters)"
name: "withFilters(List<String> filters)"
nameWithType: "GatewayRouteConfigProperties.withFilters(List<String> filters)"
summary: "Set the filters property: To modify the request before sending it to the target endpoint, or the received response in app level."
parameters:
- description: "the filters value to set."
name: "filters"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public GatewayRouteConfigProperties withFilters(List<String> filters)"
desc: "Set the filters property: To modify the request before sending it to the target endpoint, or the received response in app level."
returns:
description: "the GatewayRouteConfigProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withOpenApi(com.azure.resourcemanager.appplatform.models.GatewayRouteConfigOpenApiProperties)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withOpenApi(GatewayRouteConfigOpenApiProperties openApi)"
name: "withOpenApi(GatewayRouteConfigOpenApiProperties openApi)"
nameWithType: "GatewayRouteConfigProperties.withOpenApi(GatewayRouteConfigOpenApiProperties openApi)"
summary: "Set the open<wbr>Api property: OpenAPI properties of Spring Cloud Gateway route config."
parameters:
- description: "the openApi value to set."
name: "openApi"
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigOpenApiProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigOpenApiProperties&text=GatewayRouteConfigOpenApiProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public GatewayRouteConfigProperties withOpenApi(GatewayRouteConfigOpenApiProperties openApi)"
desc: "Set the openApi property: OpenAPI properties of Spring Cloud Gateway route config."
returns:
description: "the GatewayRouteConfigProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withPredicates(java.util.List<java.lang.String>)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withPredicates(List<String> predicates)"
name: "withPredicates(List<String> predicates)"
nameWithType: "GatewayRouteConfigProperties.withPredicates(List<String> predicates)"
summary: "Set the predicates property: A number of conditions to evaluate a route for each request in app level."
parameters:
- description: "the predicates value to set."
name: "predicates"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public GatewayRouteConfigProperties withPredicates(List<String> predicates)"
desc: "Set the predicates property: A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request."
returns:
description: "the GatewayRouteConfigProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withProtocol(com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProtocol)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withProtocol(GatewayRouteConfigProtocol protocol)"
name: "withProtocol(GatewayRouteConfigProtocol protocol)"
nameWithType: "GatewayRouteConfigProperties.withProtocol(GatewayRouteConfigProtocol protocol)"
summary: "Set the protocol property: Protocol of routed Azure Spring Apps applications."
parameters:
- description: "the protocol value to set."
name: "protocol"
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProtocol?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProtocol&text=GatewayRouteConfigProtocol\" data-throw-if-not-resolved=\"False\" />"
syntax: "public GatewayRouteConfigProperties withProtocol(GatewayRouteConfigProtocol protocol)"
desc: "Set the protocol property: Protocol of routed Azure Spring Apps applications."
returns:
description: "the GatewayRouteConfigProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withRoutes(java.util.List<com.azure.resourcemanager.appplatform.models.GatewayApiRoute>)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withRoutes(List<GatewayApiRoute> routes)"
name: "withRoutes(List<GatewayApiRoute> routes)"
nameWithType: "GatewayRouteConfigProperties.withRoutes(List<GatewayApiRoute> routes)"
summary: "Set the routes property: Array of API routes, each route contains properties such as \\`title\\`, \\`uri\\`, \\`sso<wbr>Enabled\\`, \\`predicates\\`, \\`filters\\`."
parameters:
- description: "the routes value to set."
name: "routes"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayApiRoute?alt=com.azure.resourcemanager.appplatform.models.GatewayApiRoute&text=GatewayApiRoute\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public GatewayRouteConfigProperties withRoutes(List<GatewayApiRoute> routes)"
desc: "Set the routes property: Array of API routes, each route contains properties such as \\`title\\`, \\`uri\\`, \\`ssoEnabled\\`, \\`predicates\\`, \\`filters\\`."
returns:
description: "the GatewayRouteConfigProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withSsoEnabled(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties.withSsoEnabled(Boolean ssoEnabled)"
name: "withSsoEnabled(Boolean ssoEnabled)"
nameWithType: "GatewayRouteConfigProperties.withSsoEnabled(Boolean ssoEnabled)"
summary: "Set the sso<wbr>Enabled property: Enable Single Sign-On in app level."
parameters:
- description: "the ssoEnabled value to set."
name: "ssoEnabled"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public GatewayRouteConfigProperties withSsoEnabled(Boolean ssoEnabled)"
desc: "Set the ssoEnabled property: Enable Single Sign-On in app level."
returns:
description: "the GatewayRouteConfigProperties object itself."
type: "<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "API route config of the Spring Cloud Gateway."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties?alt=com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties&text=GatewayRouteConfigProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.appplatform.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-appplatform:2.44.0