다음을 통해 공유

ApiUpdateContract Class

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
  • java.lang.Object
    • com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract

public class ApiUpdateContract

API update contract details.

Constructor Summary

Constructor Description
ApiUpdateContract()

Method Summary

Modifier and Type Method and Description
java.lang.String apiRevision()

Get describes the Revision of the Api.
java.lang.String apiRevisionDescription()

Get description of the Api Revision.
ApiType apiType()

Get type of API.
java.lang.String apiVersion()

Get indicates the Version identifier of the API if the API is versioned.
java.lang.String apiVersionDescription()

Get description of the Api Version.
java.lang.String apiVersionSetId()

Get a resource identifier for the related ApiVersionSet.
AuthenticationSettingsContract authenticationSettings()

Get collection of authentication settings included into this API.
java.lang.String description()

Get description of the API.
java.lang.String displayName()

Get aPI name.
java.lang.Boolean isCurrent()

Get indicates if API revision is current api revision.
java.lang.Boolean isOnline()

Get indicates if API revision is accessible via the gateway.
java.lang.String path()

Get relative URL uniquely identifying this API and all of its resource paths within the API Management service instance.
java.util.List<Protocol> protocols()

Get describes on which protocols the operations in this API can be invoked.
java.lang.String serviceUrl()

Get absolute URL of the backend service implementing this API.
SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames()

Get protocols over which API is made available.
java.lang.Boolean subscriptionRequired()

Get specifies whether an API or Product subscription is required for accessing the API.
ApiUpdateContract withApiRevision(String apiRevision)

Set describes the Revision of the Api.
ApiUpdateContract withApiRevisionDescription(String apiRevisionDescription)

Set description of the Api Revision.
ApiUpdateContract withApiType(ApiType apiType)

Set type of API.
ApiUpdateContract withApiVersion(String apiVersion)

Set indicates the Version identifier of the API if the API is versioned.
ApiUpdateContract withApiVersionDescription(String apiVersionDescription)

Set description of the Api Version.
ApiUpdateContract withApiVersionSetId(String apiVersionSetId)

Set a resource identifier for the related ApiVersionSet.
ApiUpdateContract withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)

Set collection of authentication settings included into this API.
ApiUpdateContract withDescription(String description)

Set description of the API.
ApiUpdateContract withDisplayName(String displayName)

Set aPI name.
ApiUpdateContract withIsCurrent(Boolean isCurrent)

Set indicates if API revision is current api revision.
ApiUpdateContract withPath(String path)

Set relative URL uniquely identifying this API and all of its resource paths within the API Management service instance.
ApiUpdateContract withProtocols(List<Protocol> protocols)

Set describes on which protocols the operations in this API can be invoked.
ApiUpdateContract withServiceUrl(String serviceUrl)

Set absolute URL of the backend service implementing this API.
ApiUpdateContract withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

Set protocols over which API is made available.
ApiUpdateContract withSubscriptionRequired(Boolean subscriptionRequired)

Set specifies whether an API or Product subscription is required for accessing the API.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ApiUpdateContract

public ApiUpdateContract()

Method Details

apiRevision

public String apiRevision()

Get 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 description of the Api Revision.

Returns:

the apiRevisionDescription value

apiType

public ApiType apiType()

Get type of API. Possible values include: 'http', 'soap'.

Returns:

the apiType value

apiVersion

public String apiVersion()

Get indicates the Version identifier of the API if the API is versioned.

Returns:

the apiVersion value

apiVersionDescription

public String apiVersionDescription()

Get description of the Api Version.

Returns:

the apiVersionDescription value

apiVersionSetId

public String apiVersionSetId()

Get a resource identifier for the related ApiVersionSet.

Returns:

the apiVersionSetId value

authenticationSettings

public AuthenticationSettingsContract authenticationSettings()

Get collection of authentication settings included into this API.

Returns:

the authenticationSettings value

description

public String description()

Get description of the API. May include HTML formatting tags.

Returns:

the description value

displayName

public String displayName()

Get aPI name.

Returns:

the displayName value

isCurrent

public Boolean isCurrent()

Get indicates if API revision is current api revision.

Returns:

the isCurrent value

isOnline

public Boolean isOnline()

Get indicates if API revision is accessible via the gateway.

Returns:

the isOnline value

path

public String path()

Get 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<Protocol> protocols()

Get describes on which protocols the operations in this API can be invoked.

Returns:

the protocols value

serviceUrl

public String serviceUrl()

Get absolute URL of the backend service implementing this API.

Returns:

the serviceUrl value

subscriptionKeyParameterNames

public SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames()

Get protocols over which API is made available.

Returns:

the subscriptionKeyParameterNames value

subscriptionRequired

public Boolean subscriptionRequired()

Get specifies whether an API or Product subscription is required for accessing the API.

Returns:

the subscriptionRequired value

withApiRevision

public ApiUpdateContract withApiRevision(String apiRevision)

Set 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 description of the Api Revision.

Parameters:

apiRevisionDescription - the apiRevisionDescription value to set

Returns:

the ApiUpdateContract object itself.

withApiType

public ApiUpdateContract withApiType(ApiType apiType)

Set type of API. Possible values include: 'http', 'soap'.

Parameters:

apiType - the apiType value to set

Returns:

the ApiUpdateContract object itself.

withApiVersion

public ApiUpdateContract withApiVersion(String apiVersion)

Set 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 description of the Api Version.

Parameters:

apiVersionDescription - the apiVersionDescription value to set

Returns:

the ApiUpdateContract object itself.

withApiVersionSetId

public ApiUpdateContract withApiVersionSetId(String apiVersionSetId)

Set 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 collection of authentication settings included into this API.

Parameters:

authenticationSettings - the authenticationSettings value to set

Returns:

the ApiUpdateContract object itself.

withDescription

public ApiUpdateContract withDescription(String description)

Set 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 aPI name.

Parameters:

displayName - the displayName value to set

Returns:

the ApiUpdateContract object itself.

withIsCurrent

public ApiUpdateContract withIsCurrent(Boolean isCurrent)

Set indicates if API revision is current api revision.

Parameters:

isCurrent - the isCurrent value to set

Returns:

the ApiUpdateContract object itself.

withPath

public ApiUpdateContract withPath(String path)

Set 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<Protocol> protocols)

Set 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 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 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 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.

Applies to