ApiUpdateContract Class

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

• java.lang.Object
• • com.azure.resourcemanager.apimanagement.models.ApiUpdateContract

public final class ApiUpdateContract

API update contract details.

Constructor Summary

Constructor	Description
ApiUpdateContract()	Creates an instance of ApiUpdateContract class.

Method Summary

Modifier and Type	Method and 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.
String	displayName() Get the displayName property: API name.
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.
String	path() Get the path property: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance.
List<Protocol>	protocols() Get the protocols property: Describes on which protocols the operations in this API can be invoked.
String	serviceUrl() Get the serviceUrl property: Absolute URL of the backend service implementing this 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.
ApiUpdateContract	withApiRevision(String apiRevision) Set the apiRevision property: Describes the revision of the API.
ApiUpdateContract	withApiRevisionDescription(String apiRevisionDescription) Set the apiRevisionDescription property: Description of the API Revision.
ApiUpdateContract	withApiType(ApiType apiType) Set the apiType property: Type of API.
ApiUpdateContract	withApiVersion(String apiVersion) Set the apiVersion property: Indicates the version identifier of the API if the API is versioned.
ApiUpdateContract	withApiVersionDescription(String apiVersionDescription) Set the apiVersionDescription property: Description of the API Version.
ApiUpdateContract	withApiVersionSetId(String apiVersionSetId) Set the apiVersionSetId property: A resource identifier for the related ApiVersionSet.
ApiUpdateContract	withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings) Set the authenticationSettings property: Collection of authentication settings included into this API.
ApiUpdateContract	withContact(ApiContactInformation contact) Set the contact property: Contact information for the API.
ApiUpdateContract	withDescription(String description) Set the description property: Description of the API.
ApiUpdateContract	withDisplayName(String displayName) Set the displayName property: API name.
ApiUpdateContract	withIsCurrent(Boolean isCurrent) Set the isCurrent property: Indicates if API revision is current api revision.
ApiUpdateContract	withLicense(ApiLicenseInformation license) Set the license property: License information for the API.
ApiUpdateContract	withPath(String path) Set the path property: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance.
ApiUpdateContract	withProtocols(List<Protocol> protocols) Set the protocols property: Describes on which protocols the operations in this API can be invoked.
ApiUpdateContract	withServiceUrl(String serviceUrl) Set the serviceUrl property: Absolute URL of the backend service implementing this API.
ApiUpdateContract	withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames) Set the subscriptionKeyParameterNames property: Protocols over which API is made available.
ApiUpdateContract	withSubscriptionRequired(Boolean subscriptionRequired) Set the subscriptionRequired property: Specifies whether an API or Product subscription is required for accessing the API.
ApiUpdateContract	withTermsOfServiceUrl(String termsOfServiceUrl) Set the termsOfServiceUrl property: A URL to the Terms of Service for the API.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ApiUpdateContract

public ApiUpdateContract()

Creates an instance of ApiUpdateContract class.

Method Details

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.

apiRevisionDescription

public String apiRevisionDescription()

Get the apiRevisionDescription property: Description of the API Revision.

Returns:

the apiRevisionDescription value.

apiType

public ApiType apiType()

Get the apiType property: Type of API.

Returns:

the apiType value.

apiVersion

public String apiVersion()

Get the apiVersion property: Indicates the version identifier of the API if the API is versioned.

Returns:

the apiVersion value.

apiVersionDescription

public String apiVersionDescription()

Get the apiVersionDescription property: Description of the API Version.

Returns:

the apiVersionDescription value.

apiVersionSetId

public String apiVersionSetId()

Get the apiVersionSetId property: A resource identifier for the related ApiVersionSet.

Returns:

the apiVersionSetId value.

authenticationSettings

public AuthenticationSettingsContract authenticationSettings()

Get the authenticationSettings property: Collection of authentication settings included into this API.

Returns:

the authenticationSettings value.

contact

public ApiContactInformation contact()

Get the contact property: Contact information for the API.

Returns:

the contact value.

description

public String description()

Get the description property: Description of the API. May include HTML formatting tags.

Returns:

the description value.

displayName

public String displayName()

Get the displayName property: API name.

Returns:

the displayName value.

isCurrent

public Boolean isCurrent()

Get the isCurrent property: Indicates if API revision is current api revision.

Returns:

the isCurrent value.

isOnline

public Boolean isOnline()

Get the isOnline property: Indicates if API revision is accessible via the gateway.

Returns:

the isOnline value.

license

public ApiLicenseInformation license()

Get the license property: License information for the API.

Returns:

the license value.

path

public String path()

Get the path property: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Returns:

the path value.

protocols

public List protocols()

Get the protocols property: Describes on which protocols the operations in this API can be invoked.

Returns:

the protocols value.

serviceUrl

public String serviceUrl()

Get the serviceUrl property: Absolute URL of the backend service implementing this API.

Returns:

the serviceUrl value.

subscriptionKeyParameterNames

public SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames()

Get the subscriptionKeyParameterNames property: Protocols over which API is made available.

Returns:

the subscriptionKeyParameterNames value.

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.

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.

validate

public void validate()

Validates the instance.

withApiRevision

public ApiUpdateContract 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 ApiUpdateContract object itself.

withApiRevisionDescription

public ApiUpdateContract withApiRevisionDescription(String apiRevisionDescription)

Set the apiRevisionDescription property: Description of the API Revision.

Parameters:

apiRevisionDescription - the apiRevisionDescription value to set.

Returns:

the ApiUpdateContract object itself.

withApiType

public ApiUpdateContract withApiType(ApiType apiType)

Set the apiType property: Type of API.

Parameters:

apiType - the apiType value to set.

Returns:

the ApiUpdateContract object itself.

withApiVersion

public ApiUpdateContract 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 ApiUpdateContract object itself.

withApiVersionDescription

public ApiUpdateContract withApiVersionDescription(String apiVersionDescription)

Set the apiVersionDescription property: Description of the API Version.

Parameters:

apiVersionDescription - the apiVersionDescription value to set.

Returns:

the ApiUpdateContract object itself.

withApiVersionSetId

public ApiUpdateContract withApiVersionSetId(String apiVersionSetId)

Set the apiVersionSetId property: A resource identifier for the related ApiVersionSet.

Parameters:

apiVersionSetId - the apiVersionSetId value to set.

Returns:

the ApiUpdateContract object itself.

withAuthenticationSettings

public ApiUpdateContract withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)

Set the authenticationSettings property: Collection of authentication settings included into this API.

Parameters:

authenticationSettings - the authenticationSettings value to set.

Returns:

the ApiUpdateContract object itself.

withContact

public ApiUpdateContract withContact(ApiContactInformation contact)

Set the contact property: Contact information for the API.

Parameters:

contact - the contact value to set.

Returns:

the ApiUpdateContract object itself.

withDescription

public ApiUpdateContract 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 ApiUpdateContract object itself.

withDisplayName

public ApiUpdateContract withDisplayName(String displayName)

Set the displayName property: API name.

Parameters:

displayName - the displayName value to set.

Returns:

the ApiUpdateContract object itself.

withIsCurrent

public ApiUpdateContract withIsCurrent(Boolean isCurrent)

Set the isCurrent property: Indicates if API revision is current api revision.

Parameters:

isCurrent - the isCurrent value to set.

Returns:

the ApiUpdateContract object itself.

withLicense

public ApiUpdateContract withLicense(ApiLicenseInformation license)

Set the license property: License information for the API.

Parameters:

license - the license value to set.

Returns:

the ApiUpdateContract object itself.

withPath

public ApiUpdateContract withPath(String path)

Set the path property: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.

Parameters:

path - the path value to set.

Returns:

the ApiUpdateContract object itself.

withProtocols

public ApiUpdateContract withProtocols(List protocols)

Set the protocols property: Describes on which protocols the operations in this API can be invoked.

Parameters:

protocols - the protocols value to set.

Returns:

the ApiUpdateContract object itself.

withServiceUrl

public ApiUpdateContract withServiceUrl(String serviceUrl)

Set the serviceUrl property: Absolute URL of the backend service implementing this API.

Parameters:

serviceUrl - the serviceUrl value to set.

Returns:

the ApiUpdateContract object itself.

withSubscriptionKeyParameterNames

public ApiUpdateContract withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

Set the subscriptionKeyParameterNames property: Protocols over which API is made available.

Parameters:

subscriptionKeyParameterNames - the subscriptionKeyParameterNames value to set.

Returns:

the ApiUpdateContract object itself.

withSubscriptionRequired

public ApiUpdateContract 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 ApiUpdateContract object itself.

withTermsOfServiceUrl

public ApiUpdateContract 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 ApiUpdateContract object itself.