Class SchemaContractInner
java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.apimanagement.fluent.models.SchemaContractInner
- All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class SchemaContractInner
extends com.azure.core.management.ProxyResource
API Schema Contract details.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the components property: Types definitions.Get the contentType property: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616.Get the definitions property: Types definitions.static SchemaContractInnerfromJson(com.azure.json.JsonReader jsonReader) Reads an instance of SchemaContractInner from the JsonReader.id()Get the id property: Fully qualified resource Id for the resource.name()Get the name property: The name of the resource.Get the provisioningState property: The provisioning state.com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) type()Get the type property: The type of the resource.voidvalidate()Validates the instance.value()Get the value property: Json escaped string defining the document representing the Schema.withComponents(Object components) Set the components property: Types definitions.withContentType(String contentType) Set the contentType property: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616.withDefinitions(Object definitions) Set the definitions property: Types definitions.Set the value property: Json escaped string defining the document representing the Schema.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
-
SchemaContractInner
public SchemaContractInner()Creates an instance of SchemaContractInner class.
-
-
Method Details
-
type
Get the type property: The type of the resource.- Overrides:
typein classcom.azure.core.management.ProxyResource- Returns:
- the type value.
-
name
Get the name property: The name of the resource.- Overrides:
namein classcom.azure.core.management.ProxyResource- Returns:
- the name value.
-
id
Get the id property: Fully qualified resource Id for the resource.- Overrides:
idin classcom.azure.core.management.ProxyResource- Returns:
- the id value.
-
contentType
Get the contentType property: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml` </br> - `OData Schema` use `application/vnd.ms-azure-apim.odata.schema` </br> - `gRPC Schema` use `text/protobuf`.- Returns:
- the contentType value.
-
withContentType
Set the contentType property: Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml` </br> - `OData Schema` use `application/vnd.ms-azure-apim.odata.schema` </br> - `gRPC Schema` use `text/protobuf`.- Parameters:
contentType- the contentType value to set.- Returns:
- the SchemaContractInner object itself.
-
provisioningState
Get the provisioningState property: The provisioning state.- Returns:
- the provisioningState value.
-
value
Get the value property: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.- Returns:
- the value value.
-
withValue
Set the value property: Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.- Parameters:
value- the value value to set.- Returns:
- the SchemaContractInner object itself.
-
definitions
Get the definitions property: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.- Returns:
- the definitions value.
-
withDefinitions
Set the definitions property: Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.- Parameters:
definitions- the definitions value to set.- Returns:
- the SchemaContractInner object itself.
-
components
Get the components property: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.- Returns:
- the components value.
-
withComponents
Set the components property: Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.- Parameters:
components- the components value to set.- Returns:
- the SchemaContractInner 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<com.azure.core.management.ProxyResource>- Overrides:
toJsonin classcom.azure.core.management.ProxyResource- Throws:
IOException
-
fromJson
Reads an instance of SchemaContractInner from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of SchemaContractInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IllegalStateException- If the deserialized JSON object was missing any required properties.IOException- If an error occurs while reading the SchemaContractInner.
-