Class ApiVersionSetUpdateParameters
java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiVersionSetUpdateParameters
- All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiVersionSetUpdateParameters>
public final class ApiVersionSetUpdateParameters
extends Object
implements com.azure.json.JsonSerializable<ApiVersionSetUpdateParameters>
Parameters to update or create an API Version Set Contract.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of ApiVersionSetUpdateParameters class. -
Method Summary
Modifier and TypeMethodDescriptionGet the description property: Description of API Version Set.Get the displayName property: Name of API Version Set.fromJson(com.azure.json.JsonReader jsonReader) Reads an instance of ApiVersionSetUpdateParameters from the JsonReader.com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) voidvalidate()Validates the instance.Get the versionHeaderName property: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.Get the versioningScheme property: An value that determines where the API Version identifier will be located in a HTTP request.Get the versionQueryName property: Name of query parameter that indicates the API Version if versioningScheme is set to `query`.withDescription(String description) Set the description property: Description of API Version Set.withDisplayName(String displayName) Set the displayName property: Name of API Version Set.withVersionHeaderName(String versionHeaderName) Set the versionHeaderName property: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.withVersioningScheme(VersioningScheme versioningScheme) Set the versioningScheme property: An value that determines where the API Version identifier will be located in a HTTP request.withVersionQueryName(String versionQueryName) Set the versionQueryName property: Name of query parameter that indicates the API Version if versioningScheme is set to `query`.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
ApiVersionSetUpdateParameters
public ApiVersionSetUpdateParameters()Creates an instance of ApiVersionSetUpdateParameters class.
-
-
Method Details
-
displayName
Get the displayName property: Name of API Version Set.- Returns:
- the displayName value.
-
withDisplayName
Set the displayName property: Name of API Version Set.- Parameters:
displayName- the displayName value to set.- Returns:
- the ApiVersionSetUpdateParameters object itself.
-
versioningScheme
Get the versioningScheme property: An value that determines where the API Version identifier will be located in a HTTP request.- Returns:
- the versioningScheme value.
-
withVersioningScheme
Set the versioningScheme property: An value that determines where the API Version identifier will be located in a HTTP request.- Parameters:
versioningScheme- the versioningScheme value to set.- Returns:
- the ApiVersionSetUpdateParameters object itself.
-
description
Get the description property: Description of API Version Set.- Returns:
- the description value.
-
withDescription
Set the description property: Description of API Version Set.- Parameters:
description- the description value to set.- Returns:
- the ApiVersionSetUpdateParameters object itself.
-
versionQueryName
Get the versionQueryName property: Name of query parameter that indicates the API Version if versioningScheme is set to `query`.- Returns:
- the versionQueryName value.
-
withVersionQueryName
Set the versionQueryName property: Name of query parameter that indicates the API Version if versioningScheme is set to `query`.- Parameters:
versionQueryName- the versionQueryName value to set.- Returns:
- the ApiVersionSetUpdateParameters object itself.
-
versionHeaderName
Get the versionHeaderName property: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.- Returns:
- the versionHeaderName value.
-
withVersionHeaderName
Set the versionHeaderName property: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.- Parameters:
versionHeaderName- the versionHeaderName value to set.- Returns:
- the ApiVersionSetUpdateParameters object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-
toJson
- Specified by:
toJsonin interfacecom.azure.json.JsonSerializable<ApiVersionSetUpdateParameters>- Throws:
IOException
-
fromJson
public static ApiVersionSetUpdateParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of ApiVersionSetUpdateParameters from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of ApiVersionSetUpdateParameters 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 ApiVersionSetUpdateParameters.
-