java.lang.Object
- com.azure.resourcemanager.apimanagement.models.ApiEntityBaseContract

Direct Known Subclasses:

ApiContractProperties, ApiContractUpdateProperties, ApiTagResourceContractProperties
```
public class ApiEntityBaseContract
extends Object
```
API base contract details.

Constructor Summary

Constructors
Constructor Description

ApiEntityBaseContract()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`apiRevision()`	Get the apiRevision property: Describes the revision of the API.
`String`	`apiRevisionDescription()`	Get the apiRevisionDescription property: Description of the API Revision.
`ApiType`	`apiType()`	Get the apiType property: Type of API.
`String`	`apiVersion()`	Get the apiVersion property: Indicates the version identifier of the API if the API is versioned.
`String`	`apiVersionDescription()`	Get the apiVersionDescription property: Description of the API Version.
`String`	`apiVersionSetId()`	Get the apiVersionSetId property: A resource identifier for the related ApiVersionSet.
`AuthenticationSettingsContract`	`authenticationSettings()`	Get the authenticationSettings property: Collection of authentication settings included into this API.
`ApiContactInformation`	`contact()`	Get the contact property: Contact information for the API.
`String`	`description()`	Get the description property: Description of the API.
`Boolean`	`isCurrent()`	Get the isCurrent property: Indicates if API revision is current api revision.
`Boolean`	`isOnline()`	Get the isOnline property: Indicates if API revision is accessible via the gateway.
`ApiLicenseInformation`	`license()`	Get the license property: License information for the API.
`SubscriptionKeyParameterNamesContract`	`subscriptionKeyParameterNames()`	Get the subscriptionKeyParameterNames property: Protocols over which API is made available.
`Boolean`	`subscriptionRequired()`	Get the subscriptionRequired property: Specifies whether an API or Product subscription is required for accessing the API.
`String`	`termsOfServiceUrl()`	Get the termsOfServiceUrl property: A URL to the Terms of Service for the API.
`void`	`validate()`	Validates the instance.
`ApiEntityBaseContract`	`withApiRevision(String apiRevision)`	Set the apiRevision property: Describes the revision of the API.
`ApiEntityBaseContract`	`withApiRevisionDescription(String apiRevisionDescription)`	Set the apiRevisionDescription property: Description of the API Revision.
`ApiEntityBaseContract`	`withApiType(ApiType apiType)`	Set the apiType property: Type of API.
`ApiEntityBaseContract`	`withApiVersion(String apiVersion)`	Set the apiVersion property: Indicates the version identifier of the API if the API is versioned.
`ApiEntityBaseContract`	`withApiVersionDescription(String apiVersionDescription)`	Set the apiVersionDescription property: Description of the API Version.
`ApiEntityBaseContract`	`withApiVersionSetId(String apiVersionSetId)`	Set the apiVersionSetId property: A resource identifier for the related ApiVersionSet.
`ApiEntityBaseContract`	`withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)`	Set the authenticationSettings property: Collection of authentication settings included into this API.
`ApiEntityBaseContract`	`withContact(ApiContactInformation contact)`	Set the contact property: Contact information for the API.
`ApiEntityBaseContract`	`withDescription(String description)`	Set the description property: Description of the API.
`ApiEntityBaseContract`	`withIsCurrent(Boolean isCurrent)`	Set the isCurrent property: Indicates if API revision is current api revision.
`ApiEntityBaseContract`	`withLicense(ApiLicenseInformation license)`	Set the license property: License information for the API.
`ApiEntityBaseContract`	`withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)`	Set the subscriptionKeyParameterNames property: Protocols over which API is made available.
`ApiEntityBaseContract`	`withSubscriptionRequired(Boolean subscriptionRequired)`	Set the subscriptionRequired property: Specifies whether an API or Product subscription is required for accessing the API.
`ApiEntityBaseContract`	`withTermsOfServiceUrl(String termsOfServiceUrl)`	Set the termsOfServiceUrl property: A URL to the Terms of Service for the API.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApiEntityBaseContract
```
public ApiEntityBaseContract()
```
- Method Detail
  - description
```
public String description()
```
    Get the description property: Description of the API. May include HTML formatting tags.
    
    Returns:
    
    the description value.
  - withDescription
```
public ApiEntityBaseContract withDescription(String description)
```
    Set the description property: Description of the API. May include HTML formatting tags.
    
    Parameters:
    
    description - the description value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - authenticationSettings
```
public AuthenticationSettingsContract authenticationSettings()
```
    Get the authenticationSettings property: Collection of authentication settings included into this API.
    
    Returns:
    
    the authenticationSettings value.
  - withAuthenticationSettings
```
public ApiEntityBaseContract withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)
```
    Set the authenticationSettings property: Collection of authentication settings included into this API.
    
    Parameters:
    
    authenticationSettings - the authenticationSettings value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - subscriptionKeyParameterNames
```
public SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames()
```
    Get the subscriptionKeyParameterNames property: Protocols over which API is made available.
    
    Returns:
    
    the subscriptionKeyParameterNames value.
  - withSubscriptionKeyParameterNames
```
public ApiEntityBaseContract withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)
```
    Set the subscriptionKeyParameterNames property: Protocols over which API is made available.
    
    Parameters:
    
    subscriptionKeyParameterNames - the subscriptionKeyParameterNames value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - apiType
```
public ApiType apiType()
```
    Get the apiType property: Type of API.
    
    Returns:
    
    the apiType value.
  - withApiType
```
public ApiEntityBaseContract withApiType(ApiType apiType)
```
    Set the apiType property: Type of API.
    
    Parameters:
    
    apiType - the apiType value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - apiRevision
```
public String apiRevision()
```
    Get the apiRevision property: Describes the revision of the API. If no value is provided, default revision 1 is created.
    
    Returns:
    
    the apiRevision value.
  - withApiRevision
```
public ApiEntityBaseContract withApiRevision(String apiRevision)
```
    Set the apiRevision property: Describes the revision of the API. If no value is provided, default revision 1 is created.
    
    Parameters:
    
    apiRevision - the apiRevision value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - apiVersion
```
public String apiVersion()
```
    Get the apiVersion property: Indicates the version identifier of the API if the API is versioned.
    
    Returns:
    
    the apiVersion value.
  - withApiVersion
```
public ApiEntityBaseContract withApiVersion(String apiVersion)
```
    Set the apiVersion property: Indicates the version identifier of the API if the API is versioned.
    
    Parameters:
    
    apiVersion - the apiVersion value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - isCurrent
```
public Boolean isCurrent()
```
    Get the isCurrent property: Indicates if API revision is current api revision.
    
    Returns:
    
    the isCurrent value.
  - withIsCurrent
```
public ApiEntityBaseContract withIsCurrent(Boolean isCurrent)
```
    Set the isCurrent property: Indicates if API revision is current api revision.
    
    Parameters:
    
    isCurrent - the isCurrent value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - isOnline
```
public Boolean isOnline()
```
    Get the isOnline property: Indicates if API revision is accessible via the gateway.
    
    Returns:
    
    the isOnline value.
  - apiRevisionDescription
```
public String apiRevisionDescription()
```
    Get the apiRevisionDescription property: Description of the API Revision.
    
    Returns:
    
    the apiRevisionDescription value.
  - withApiRevisionDescription
```
public ApiEntityBaseContract withApiRevisionDescription(String apiRevisionDescription)
```
    Set the apiRevisionDescription property: Description of the API Revision.
    
    Parameters:
    
    apiRevisionDescription - the apiRevisionDescription value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - apiVersionDescription
```
public String apiVersionDescription()
```
    Get the apiVersionDescription property: Description of the API Version.
    
    Returns:
    
    the apiVersionDescription value.
  - withApiVersionDescription
```
public ApiEntityBaseContract withApiVersionDescription(String apiVersionDescription)
```
    Set the apiVersionDescription property: Description of the API Version.
    
    Parameters:
    
    apiVersionDescription - the apiVersionDescription value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - apiVersionSetId
```
public String apiVersionSetId()
```
    Get the apiVersionSetId property: A resource identifier for the related ApiVersionSet.
    
    Returns:
    
    the apiVersionSetId value.
  - withApiVersionSetId
```
public ApiEntityBaseContract withApiVersionSetId(String apiVersionSetId)
```
    Set the apiVersionSetId property: A resource identifier for the related ApiVersionSet.
    
    Parameters:
    
    apiVersionSetId - the apiVersionSetId value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - subscriptionRequired
```
public Boolean subscriptionRequired()
```
    Get the subscriptionRequired property: Specifies whether an API or Product subscription is required for accessing the API.
    
    Returns:
    
    the subscriptionRequired value.
  - withSubscriptionRequired
```
public ApiEntityBaseContract withSubscriptionRequired(Boolean subscriptionRequired)
```
    Set the subscriptionRequired property: Specifies whether an API or Product subscription is required for accessing the API.
    
    Parameters:
    
    subscriptionRequired - the subscriptionRequired value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - termsOfServiceUrl
```
public String termsOfServiceUrl()
```
    Get the termsOfServiceUrl property: A URL to the Terms of Service for the API. MUST be in the format of a URL.
    
    Returns:
    
    the termsOfServiceUrl value.
  - withTermsOfServiceUrl
```
public ApiEntityBaseContract withTermsOfServiceUrl(String termsOfServiceUrl)
```
    Set the termsOfServiceUrl property: A URL to the Terms of Service for the API. MUST be in the format of a URL.
    
    Parameters:
    
    termsOfServiceUrl - the termsOfServiceUrl value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - contact
```
public ApiContactInformation contact()
```
    Get the contact property: Contact information for the API.
    
    Returns:
    
    the contact value.
  - withContact
```
public ApiEntityBaseContract withContact(ApiContactInformation contact)
```
    Set the contact property: Contact information for the API.
    
    Parameters:
    
    contact - the contact value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - license
```
public ApiLicenseInformation license()
```
    Get the license property: License information for the API.
    
    Returns:
    
    the license value.
  - withLicense
```
public ApiEntityBaseContract withLicense(ApiLicenseInformation license)
```
    Set the license property: License information for the API.
    
    Parameters:
    
    license - the license value to set.
    
    Returns:
    
    the ApiEntityBaseContract object itself.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Class ApiEntityBaseContract

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiEntityBaseContract

Method Detail

description

withDescription

authenticationSettings

withAuthenticationSettings

subscriptionKeyParameterNames

withSubscriptionKeyParameterNames

apiType

withApiType

apiRevision

withApiRevision

apiVersion

withApiVersion

isCurrent

withIsCurrent

isOnline

apiRevisionDescription

withApiRevisionDescription

apiVersionDescription

withApiVersionDescription

apiVersionSetId

withApiVersionSetId

subscriptionRequired

withSubscriptionRequired

termsOfServiceUrl

withTermsOfServiceUrl

contact

withContact

license

withLicense

validate