Share via

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

public class ApiEntityBaseContract

API base contract details.

Constructor Summary

Constructor Description
ApiEntityBaseContract()

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.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.
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.
ApiEntityBaseContract withApiRevision(String apiRevision)

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

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

Set type of API.
ApiEntityBaseContract withApiVersion(String apiVersion)

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

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

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

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

Set description of the API.
ApiEntityBaseContract withIsCurrent(Boolean isCurrent)

Set indicates if API revision is current api revision.
ApiEntityBaseContract withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

Set protocols over which API is made available.
ApiEntityBaseContract 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

ApiEntityBaseContract

public ApiEntityBaseContract()

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

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

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 ApiEntityBaseContract 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 ApiEntityBaseContract object itself.

withApiRevisionDescription

public ApiEntityBaseContract withApiRevisionDescription(String apiRevisionDescription)

Set description of the Api Revision.

Parameters:

apiRevisionDescription - the apiRevisionDescription value to set

Returns:

the ApiEntityBaseContract object itself.

withApiType

public ApiEntityBaseContract withApiType(ApiType apiType)

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

Parameters:

apiType - the apiType value to set

Returns:

the ApiEntityBaseContract object itself.

withApiVersion

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

withApiVersionDescription

public ApiEntityBaseContract withApiVersionDescription(String apiVersionDescription)

Set description of the Api Version.

Parameters:

apiVersionDescription - the apiVersionDescription value to set

Returns:

the ApiEntityBaseContract object itself.

withApiVersionSetId

public ApiEntityBaseContract withApiVersionSetId(String apiVersionSetId)

Set a resource identifier for the related ApiVersionSet.

Parameters:

apiVersionSetId - the apiVersionSetId value to set

Returns:

the ApiEntityBaseContract object itself.

withAuthenticationSettings

public ApiEntityBaseContract withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)

Set collection of authentication settings included into this API.

Parameters:

authenticationSettings - the authenticationSettings value to set

Returns:

the ApiEntityBaseContract object itself.

withDescription

public ApiEntityBaseContract withDescription(String description)

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

Parameters:

description - the description value to set

Returns:

the ApiEntityBaseContract object itself.

withIsCurrent

public ApiEntityBaseContract withIsCurrent(Boolean isCurrent)

Set indicates if API revision is current api revision.

Parameters:

isCurrent - the isCurrent value to set

Returns:

the ApiEntityBaseContract object itself.

withSubscriptionKeyParameterNames

public ApiEntityBaseContract withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

Set protocols over which API is made available.

Parameters:

subscriptionKeyParameterNames - the subscriptionKeyParameterNames value to set

Returns:

the ApiEntityBaseContract object itself.

withSubscriptionRequired

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

Applies to