通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

ApiContractProperties 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

public class ApiContractProperties
extends ApiEntityBaseContract

Api Entity Properties.

Constructor Summary

Constructor Description
ApiContractProperties()

Method Summary

Modifier and Type Method and Description
ApiVersionSetContractDetails apiVersionSet()

Get version set details.
java.lang.String displayName()

Get aPI name.
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.
java.lang.String sourceApiId()

Get aPI identifier of the source API.
ApiContractProperties withApiVersionSet(ApiVersionSetContractDetails apiVersionSet)

Set version set details.
ApiContractProperties withDisplayName(String displayName)

Set aPI name.
ApiContractProperties withPath(String path)

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

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

Set absolute URL of the backend service implementing this API.
ApiContractProperties withSourceApiId(String sourceApiId)

Set aPI identifier of the source API.

Methods inherited from ApiEntityBaseContract

apiRevision apiRevisionDescription apiType apiVersion apiVersionDescription apiVersionSetId authenticationSettings description isCurrent isOnline subscriptionKeyParameterNames subscriptionRequired withApiRevision withApiRevisionDescription withApiType withApiVersion withApiVersionDescription withApiVersionSetId withAuthenticationSettings withDescription withIsCurrent withSubscriptionKeyParameterNames withSubscriptionRequired

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

ApiContractProperties

public ApiContractProperties()

Method Details

apiVersionSet

public ApiVersionSetContractDetails apiVersionSet()

Get version set details.

Returns:

the apiVersionSet value

displayName

public String displayName()

Get aPI name. Must be 1 to 300 characters long.

Returns:

the displayName 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. Cannot be more than 2000 characters long.

Returns:

the serviceUrl value

sourceApiId

public String sourceApiId()

Get aPI identifier of the source API.

Returns:

the sourceApiId value

withApiVersionSet

public ApiContractProperties withApiVersionSet(ApiVersionSetContractDetails apiVersionSet)

Set version set details.

Parameters:

apiVersionSet - the apiVersionSet value to set

Returns:

the ApiContractProperties object itself.

withDisplayName

public ApiContractProperties withDisplayName(String displayName)

Set aPI name. Must be 1 to 300 characters long.

Parameters:

displayName - the displayName value to set

Returns:

the ApiContractProperties object itself.

withPath

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

withProtocols

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

withServiceUrl

public ApiContractProperties withServiceUrl(String serviceUrl)

Set absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.

Parameters:

serviceUrl - the serviceUrl value to set

Returns:

the ApiContractProperties object itself.

withSourceApiId

public ApiContractProperties withSourceApiId(String sourceApiId)

Set aPI identifier of the source API.

Parameters:

sourceApiId - the sourceApiId value to set

Returns:

the ApiContractProperties object itself.

Applies to