Package com.azure.resourcemanager.apimanagement.models

Class ApiTagResourceContractProperties

java.lang.Object

com.azure.resourcemanager.apimanagement.models.ApiEntityBaseContract

com.azure.resourcemanager.apimanagement.models.ApiTagResourceContractProperties

public final class ApiTagResourceContractProperties
extends ApiEntityBaseContract

API contract properties for the Tag Resources.

Constructor Summary

Constructors

Constructor	Description
ApiTagResourceContractProperties()

Method Summary

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

Methods inherited from class com.azure.resourcemanager.apimanagement.models.ApiEntityBaseContract

apiRevision, apiRevisionDescription, apiType, apiVersion, apiVersionDescription, apiVersionSetId, authenticationSettings, contact, description, isCurrent, isOnline, license, subscriptionKeyParameterNames, subscriptionRequired, termsOfServiceUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiTagResourceContractProperties

public ApiTagResourceContractProperties()

Method Detail

id

public String id()

Get the id property: API identifier in the form /apis/{apiId}.

Returns:

the id value.

withId

public ApiTagResourceContractProperties withId(String id)

Set the id property: API identifier in the form /apis/{apiId}.

Parameters:

id - the id value to set.

Returns:

the ApiTagResourceContractProperties object itself.

name

public String name()

Get the name property: API name.

Returns:

the name value.

withName

public ApiTagResourceContractProperties withName(String name)

Set the name property: API name.

Parameters:

name - the name value to set.

Returns:

the ApiTagResourceContractProperties object itself.

serviceUrl

public String serviceUrl()

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

Returns:

the serviceUrl value.

withServiceUrl

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

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.

withPath

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

protocols

public List<Protocol> protocols()

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

Returns:

the protocols value.

withProtocols

public ApiTagResourceContractProperties withProtocols(List<Protocol> 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 ApiTagResourceContractProperties object itself.

withDescription

public ApiTagResourceContractProperties withDescription(String description)

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

Overrides:

withDescription in class ApiEntityBaseContract

Parameters:

description - the description value to set.

Returns:

the ApiEntityBaseContract object itself.

withAuthenticationSettings

public ApiTagResourceContractProperties withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)

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

Overrides:

withAuthenticationSettings in class ApiEntityBaseContract

Parameters:

authenticationSettings - the authenticationSettings value to set.

Returns:

the ApiEntityBaseContract object itself.

withSubscriptionKeyParameterNames

public ApiTagResourceContractProperties withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

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

Overrides:

withSubscriptionKeyParameterNames in class ApiEntityBaseContract

Parameters:

subscriptionKeyParameterNames - the subscriptionKeyParameterNames value to set.

Returns:

the ApiEntityBaseContract object itself.

withApiType

public ApiTagResourceContractProperties withApiType(ApiType apiType)

Set the apiType property: Type of API.

Overrides:

withApiType in class ApiEntityBaseContract

Parameters:

apiType - the apiType value to set.

Returns:

the ApiEntityBaseContract object itself.

withApiRevision

public ApiTagResourceContractProperties withApiRevision(String apiRevision)

Set the apiRevision property: Describes the revision of the API. If no value is provided, default revision 1 is created.

Overrides:

withApiRevision in class ApiEntityBaseContract

Parameters:

apiRevision - the apiRevision value to set.

Returns:

the ApiEntityBaseContract object itself.

withApiVersion

public ApiTagResourceContractProperties withApiVersion(String apiVersion)

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

Overrides:

withApiVersion in class ApiEntityBaseContract

Parameters:

apiVersion - the apiVersion value to set.

Returns:

the ApiEntityBaseContract object itself.

withIsCurrent

public ApiTagResourceContractProperties withIsCurrent(Boolean isCurrent)

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

Overrides:

withIsCurrent in class ApiEntityBaseContract

Parameters:

isCurrent - the isCurrent value to set.

Returns:

the ApiEntityBaseContract object itself.

withApiRevisionDescription

public ApiTagResourceContractProperties withApiRevisionDescription(String apiRevisionDescription)

Set the apiRevisionDescription property: Description of the API Revision.

Overrides:

withApiRevisionDescription in class ApiEntityBaseContract

Parameters:

apiRevisionDescription - the apiRevisionDescription value to set.

Returns:

the ApiEntityBaseContract object itself.

withApiVersionDescription

public ApiTagResourceContractProperties withApiVersionDescription(String apiVersionDescription)

Set the apiVersionDescription property: Description of the API Version.

Overrides:

withApiVersionDescription in class ApiEntityBaseContract

Parameters:

apiVersionDescription - the apiVersionDescription value to set.

Returns:

the ApiEntityBaseContract object itself.

withApiVersionSetId

public ApiTagResourceContractProperties withApiVersionSetId(String apiVersionSetId)

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

Overrides:

withApiVersionSetId in class ApiEntityBaseContract

Parameters:

apiVersionSetId - the apiVersionSetId value to set.

Returns:

the ApiEntityBaseContract object itself.

withSubscriptionRequired

public ApiTagResourceContractProperties withSubscriptionRequired(Boolean subscriptionRequired)

Set the subscriptionRequired property: Specifies whether an API or Product subscription is required for accessing the API.

Overrides:

withSubscriptionRequired in class ApiEntityBaseContract

Parameters:

subscriptionRequired - the subscriptionRequired value to set.

Returns:

the ApiEntityBaseContract object itself.

withTermsOfServiceUrl

public ApiTagResourceContractProperties 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.

Overrides:

withTermsOfServiceUrl in class ApiEntityBaseContract

Parameters:

termsOfServiceUrl - the termsOfServiceUrl value to set.

Returns:

the ApiEntityBaseContract object itself.

withContact

public ApiTagResourceContractProperties withContact(ApiContactInformation contact)

Set the contact property: Contact information for the API.

Overrides:

withContact in class ApiEntityBaseContract

Parameters:

contact - the contact value to set.

Returns:

the ApiEntityBaseContract object itself.

withLicense

public ApiTagResourceContractProperties withLicense(ApiLicenseInformation license)

Set the license property: License information for the API.

Overrides:

withLicense in class ApiEntityBaseContract

Parameters:

license - the license value to set.

Returns:

the ApiEntityBaseContract object itself.

validate

public void validate()

Validates the instance.

Overrides:

validate in class ApiEntityBaseContract

Throws:

IllegalArgumentException - thrown if the instance is not valid.