406 строки
31 KiB
YAML
406 строки
31 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract"
|
|
name: "ApiUpdateContract"
|
|
nameWithType: "ApiUpdateContract"
|
|
summary: "API update contract details."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **ApiUpdateContract**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.ApiUpdateContract()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.ApiUpdateContract()"
|
|
name: "ApiUpdateContract()"
|
|
nameWithType: "ApiUpdateContract.ApiUpdateContract()"
|
|
syntax: "public ApiUpdateContract()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiRevision()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiRevision()"
|
|
name: "apiRevision()"
|
|
nameWithType: "ApiUpdateContract.apiRevision()"
|
|
summary: "Get describes the Revision of the Api."
|
|
syntax: "public String apiRevision()"
|
|
desc: "Get describes the Revision of the Api. If no value is provided, default revision 1 is created."
|
|
returns:
|
|
description: "the apiRevision value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiRevisionDescription()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiRevisionDescription()"
|
|
name: "apiRevisionDescription()"
|
|
nameWithType: "ApiUpdateContract.apiRevisionDescription()"
|
|
summary: "Get description of the Api Revision."
|
|
syntax: "public String apiRevisionDescription()"
|
|
desc: "Get description of the Api Revision."
|
|
returns:
|
|
description: "the apiRevisionDescription value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiType()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiType()"
|
|
name: "apiType()"
|
|
nameWithType: "ApiUpdateContract.apiType()"
|
|
summary: "Get type of API."
|
|
syntax: "public ApiType apiType()"
|
|
desc: "Get type of API. Possible values include: 'http', 'soap'."
|
|
returns:
|
|
description: "the apiType value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiType?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiType&text=ApiType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiVersion()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiVersion()"
|
|
name: "apiVersion()"
|
|
nameWithType: "ApiUpdateContract.apiVersion()"
|
|
summary: "Get indicates the Version identifier of the API if the API is versioned."
|
|
syntax: "public String apiVersion()"
|
|
desc: "Get indicates the Version identifier of the API if the API is versioned."
|
|
returns:
|
|
description: "the apiVersion value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiVersionDescription()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiVersionDescription()"
|
|
name: "apiVersionDescription()"
|
|
nameWithType: "ApiUpdateContract.apiVersionDescription()"
|
|
summary: "Get description of the Api Version."
|
|
syntax: "public String apiVersionDescription()"
|
|
desc: "Get description of the Api Version."
|
|
returns:
|
|
description: "the apiVersionDescription value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiVersionSetId()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.apiVersionSetId()"
|
|
name: "apiVersionSetId()"
|
|
nameWithType: "ApiUpdateContract.apiVersionSetId()"
|
|
summary: "Get a resource identifier for the related Api<wbr>Version<wbr>Set."
|
|
syntax: "public String apiVersionSetId()"
|
|
desc: "Get a resource identifier for the related ApiVersionSet."
|
|
returns:
|
|
description: "the apiVersionSetId value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.authenticationSettings()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.authenticationSettings()"
|
|
name: "authenticationSettings()"
|
|
nameWithType: "ApiUpdateContract.authenticationSettings()"
|
|
summary: "Get collection of authentication settings included into this API."
|
|
syntax: "public AuthenticationSettingsContract authenticationSettings()"
|
|
desc: "Get collection of authentication settings included into this API."
|
|
returns:
|
|
description: "the authenticationSettings value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthenticationSettingsContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthenticationSettingsContract&text=AuthenticationSettingsContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.description()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.description()"
|
|
name: "description()"
|
|
nameWithType: "ApiUpdateContract.description()"
|
|
summary: "Get description of the API."
|
|
syntax: "public String description()"
|
|
desc: "Get description of the API. May include HTML formatting tags."
|
|
returns:
|
|
description: "the description value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.displayName()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.displayName()"
|
|
name: "displayName()"
|
|
nameWithType: "ApiUpdateContract.displayName()"
|
|
summary: "Get aPI name."
|
|
syntax: "public String displayName()"
|
|
desc: "Get aPI name."
|
|
returns:
|
|
description: "the displayName value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.isCurrent()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.isCurrent()"
|
|
name: "isCurrent()"
|
|
nameWithType: "ApiUpdateContract.isCurrent()"
|
|
summary: "Get indicates if API revision is current api revision."
|
|
syntax: "public Boolean isCurrent()"
|
|
desc: "Get indicates if API revision is current api revision."
|
|
returns:
|
|
description: "the isCurrent value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.isOnline()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.isOnline()"
|
|
name: "isOnline()"
|
|
nameWithType: "ApiUpdateContract.isOnline()"
|
|
summary: "Get indicates if API revision is accessible via the gateway."
|
|
syntax: "public Boolean isOnline()"
|
|
desc: "Get indicates if API revision is accessible via the gateway."
|
|
returns:
|
|
description: "the isOnline value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.path()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.path()"
|
|
name: "path()"
|
|
nameWithType: "ApiUpdateContract.path()"
|
|
summary: "Get relative URL uniquely identifying this API and all of its resource paths within the API Management service instance."
|
|
syntax: "public String path()"
|
|
desc: "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:
|
|
description: "the path value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.protocols()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.protocols()"
|
|
name: "protocols()"
|
|
nameWithType: "ApiUpdateContract.protocols()"
|
|
summary: "Get describes on which protocols the operations in this API can be invoked."
|
|
syntax: "public List<Protocol> protocols()"
|
|
desc: "Get describes on which protocols the operations in this API can be invoked."
|
|
returns:
|
|
description: "the protocols value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.Protocol?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.Protocol&text=Protocol\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.serviceUrl()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.serviceUrl()"
|
|
name: "serviceUrl()"
|
|
nameWithType: "ApiUpdateContract.serviceUrl()"
|
|
summary: "Get absolute URL of the backend service implementing this API."
|
|
syntax: "public String serviceUrl()"
|
|
desc: "Get absolute URL of the backend service implementing this API."
|
|
returns:
|
|
description: "the serviceUrl value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.subscriptionKeyParameterNames()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.subscriptionKeyParameterNames()"
|
|
name: "subscriptionKeyParameterNames()"
|
|
nameWithType: "ApiUpdateContract.subscriptionKeyParameterNames()"
|
|
summary: "Get protocols over which API is made available."
|
|
syntax: "public SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames()"
|
|
desc: "Get protocols over which API is made available."
|
|
returns:
|
|
description: "the subscriptionKeyParameterNames value"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionKeyParameterNamesContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionKeyParameterNamesContract&text=SubscriptionKeyParameterNamesContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.subscriptionRequired()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.subscriptionRequired()"
|
|
name: "subscriptionRequired()"
|
|
nameWithType: "ApiUpdateContract.subscriptionRequired()"
|
|
summary: "Get specifies whether an API or Product subscription is required for accessing the API."
|
|
syntax: "public Boolean subscriptionRequired()"
|
|
desc: "Get specifies whether an API or Product subscription is required for accessing the API."
|
|
returns:
|
|
description: "the subscriptionRequired value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiRevision(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiRevision(String apiRevision)"
|
|
name: "withApiRevision(String apiRevision)"
|
|
nameWithType: "ApiUpdateContract.withApiRevision(String apiRevision)"
|
|
summary: "Set describes the Revision of the Api."
|
|
parameters:
|
|
- description: "the apiRevision value to set"
|
|
name: "apiRevision"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withApiRevision(String apiRevision)"
|
|
desc: "Set describes the Revision of the Api. If no value is provided, default revision 1 is created."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiRevisionDescription(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiRevisionDescription(String apiRevisionDescription)"
|
|
name: "withApiRevisionDescription(String apiRevisionDescription)"
|
|
nameWithType: "ApiUpdateContract.withApiRevisionDescription(String apiRevisionDescription)"
|
|
summary: "Set description of the Api Revision."
|
|
parameters:
|
|
- description: "the apiRevisionDescription value to set"
|
|
name: "apiRevisionDescription"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withApiRevisionDescription(String apiRevisionDescription)"
|
|
desc: "Set description of the Api Revision."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiType(com.microsoft.azure.management.apimanagement.v2019_01_01.ApiType)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiType(ApiType apiType)"
|
|
name: "withApiType(ApiType apiType)"
|
|
nameWithType: "ApiUpdateContract.withApiType(ApiType apiType)"
|
|
summary: "Set type of API."
|
|
parameters:
|
|
- description: "the apiType value to set"
|
|
name: "apiType"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiType?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiType&text=ApiType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withApiType(ApiType apiType)"
|
|
desc: "Set type of API. Possible values include: 'http', 'soap'."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiVersion(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiVersion(String apiVersion)"
|
|
name: "withApiVersion(String apiVersion)"
|
|
nameWithType: "ApiUpdateContract.withApiVersion(String apiVersion)"
|
|
summary: "Set indicates the Version identifier of the API if the API is versioned."
|
|
parameters:
|
|
- description: "the apiVersion value to set"
|
|
name: "apiVersion"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withApiVersion(String apiVersion)"
|
|
desc: "Set indicates the Version identifier of the API if the API is versioned."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiVersionDescription(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiVersionDescription(String apiVersionDescription)"
|
|
name: "withApiVersionDescription(String apiVersionDescription)"
|
|
nameWithType: "ApiUpdateContract.withApiVersionDescription(String apiVersionDescription)"
|
|
summary: "Set description of the Api Version."
|
|
parameters:
|
|
- description: "the apiVersionDescription value to set"
|
|
name: "apiVersionDescription"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withApiVersionDescription(String apiVersionDescription)"
|
|
desc: "Set description of the Api Version."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiVersionSetId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withApiVersionSetId(String apiVersionSetId)"
|
|
name: "withApiVersionSetId(String apiVersionSetId)"
|
|
nameWithType: "ApiUpdateContract.withApiVersionSetId(String apiVersionSetId)"
|
|
summary: "Set a resource identifier for the related Api<wbr>Version<wbr>Set."
|
|
parameters:
|
|
- description: "the apiVersionSetId value to set"
|
|
name: "apiVersionSetId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withApiVersionSetId(String apiVersionSetId)"
|
|
desc: "Set a resource identifier for the related ApiVersionSet."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withAuthenticationSettings(com.microsoft.azure.management.apimanagement.v2019_01_01.AuthenticationSettingsContract)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)"
|
|
name: "withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)"
|
|
nameWithType: "ApiUpdateContract.withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)"
|
|
summary: "Set collection of authentication settings included into this API."
|
|
parameters:
|
|
- description: "the authenticationSettings value to set"
|
|
name: "authenticationSettings"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthenticationSettingsContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthenticationSettingsContract&text=AuthenticationSettingsContract\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)"
|
|
desc: "Set collection of authentication settings included into this API."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withDescription(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withDescription(String description)"
|
|
name: "withDescription(String description)"
|
|
nameWithType: "ApiUpdateContract.withDescription(String description)"
|
|
summary: "Set description of the API."
|
|
parameters:
|
|
- description: "the description value to set"
|
|
name: "description"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withDescription(String description)"
|
|
desc: "Set description of the API. May include HTML formatting tags."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withDisplayName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withDisplayName(String displayName)"
|
|
name: "withDisplayName(String displayName)"
|
|
nameWithType: "ApiUpdateContract.withDisplayName(String displayName)"
|
|
summary: "Set aPI name."
|
|
parameters:
|
|
- description: "the displayName value to set"
|
|
name: "displayName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withDisplayName(String displayName)"
|
|
desc: "Set aPI name."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withIsCurrent(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withIsCurrent(Boolean isCurrent)"
|
|
name: "withIsCurrent(Boolean isCurrent)"
|
|
nameWithType: "ApiUpdateContract.withIsCurrent(Boolean isCurrent)"
|
|
summary: "Set indicates if API revision is current api revision."
|
|
parameters:
|
|
- description: "the isCurrent value to set"
|
|
name: "isCurrent"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withIsCurrent(Boolean isCurrent)"
|
|
desc: "Set indicates if API revision is current api revision."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withPath(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withPath(String path)"
|
|
name: "withPath(String path)"
|
|
nameWithType: "ApiUpdateContract.withPath(String path)"
|
|
summary: "Set relative URL uniquely identifying this API and all of its resource paths within the API Management service instance."
|
|
parameters:
|
|
- description: "the path value to set"
|
|
name: "path"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withPath(String path)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withProtocols(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.Protocol>)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withProtocols(List<Protocol> protocols)"
|
|
name: "withProtocols(List<Protocol> protocols)"
|
|
nameWithType: "ApiUpdateContract.withProtocols(List<Protocol> protocols)"
|
|
summary: "Set describes on which protocols the operations in this API can be invoked."
|
|
parameters:
|
|
- description: "the protocols value to set"
|
|
name: "protocols"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.Protocol?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.Protocol&text=Protocol\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ApiUpdateContract withProtocols(List<Protocol> protocols)"
|
|
desc: "Set describes on which protocols the operations in this API can be invoked."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withServiceUrl(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withServiceUrl(String serviceUrl)"
|
|
name: "withServiceUrl(String serviceUrl)"
|
|
nameWithType: "ApiUpdateContract.withServiceUrl(String serviceUrl)"
|
|
summary: "Set absolute URL of the backend service implementing this API."
|
|
parameters:
|
|
- description: "the serviceUrl value to set"
|
|
name: "serviceUrl"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withServiceUrl(String serviceUrl)"
|
|
desc: "Set absolute URL of the backend service implementing this API."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withSubscriptionKeyParameterNames(com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionKeyParameterNamesContract)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)"
|
|
name: "withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)"
|
|
nameWithType: "ApiUpdateContract.withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)"
|
|
summary: "Set protocols over which API is made available."
|
|
parameters:
|
|
- description: "the subscriptionKeyParameterNames value to set"
|
|
name: "subscriptionKeyParameterNames"
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionKeyParameterNamesContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.SubscriptionKeyParameterNamesContract&text=SubscriptionKeyParameterNamesContract\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)"
|
|
desc: "Set protocols over which API is made available."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withSubscriptionRequired(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract.withSubscriptionRequired(Boolean subscriptionRequired)"
|
|
name: "withSubscriptionRequired(Boolean subscriptionRequired)"
|
|
nameWithType: "ApiUpdateContract.withSubscriptionRequired(Boolean subscriptionRequired)"
|
|
summary: "Set specifies whether an API or Product subscription is required for accessing the API."
|
|
parameters:
|
|
- description: "the subscriptionRequired value to set"
|
|
name: "subscriptionRequired"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ApiUpdateContract withSubscriptionRequired(Boolean subscriptionRequired)"
|
|
desc: "Set specifies whether an API or Product subscription is required for accessing the API."
|
|
returns:
|
|
description: "the ApiUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiUpdateContract&text=ApiUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "API update contract details."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
|
|
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
|