azure-docs-sdk-java/legacy/docs-ref-autogen/com.microsoft.azure.managem...

180 строки
14 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails"
name: "ApiVersionSetContractDetails"
nameWithType: "ApiVersionSetContractDetails"
summary: "An API Version Set contains the common configuration for a set of API Versions relating."
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 **ApiVersionSetContractDetails**"
constructors:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.ApiVersionSetContractDetails()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.ApiVersionSetContractDetails()"
name: "ApiVersionSetContractDetails()"
nameWithType: "ApiVersionSetContractDetails.ApiVersionSetContractDetails()"
syntax: "public ApiVersionSetContractDetails()"
methods:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.description()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.description()"
name: "description()"
nameWithType: "ApiVersionSetContractDetails.description()"
summary: "Get description of API Version Set."
syntax: "public String description()"
desc: "Get description of API Version Set."
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.ApiVersionSetContractDetails.id()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.id()"
name: "id()"
nameWithType: "ApiVersionSetContractDetails.id()"
summary: "Get identifier for existing API Version Set."
syntax: "public String id()"
desc: "Get identifier for existing API Version Set. Omit this value to create a new Version Set."
returns:
description: "the id 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.ApiVersionSetContractDetails.name()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.name()"
name: "name()"
nameWithType: "ApiVersionSetContractDetails.name()"
summary: "Get the display Name of the API Version Set."
syntax: "public String name()"
desc: "Get the display Name of the API Version Set."
returns:
description: "the name 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.ApiVersionSetContractDetails.versionHeaderName()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.versionHeaderName()"
name: "versionHeaderName()"
nameWithType: "ApiVersionSetContractDetails.versionHeaderName()"
summary: "Get name of HTTP header parameter that indicates the API Version if versioning<wbr>Scheme is set to \\`header\\`."
syntax: "public String versionHeaderName()"
desc: "Get name of HTTP header parameter that indicates the API Version if versioningScheme is set to \\`header\\`."
returns:
description: "the versionHeaderName 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.ApiVersionSetContractDetails.versionQueryName()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.versionQueryName()"
name: "versionQueryName()"
nameWithType: "ApiVersionSetContractDetails.versionQueryName()"
summary: "Get name of query parameter that indicates the API Version if versioning<wbr>Scheme is set to \\`query\\`."
syntax: "public String versionQueryName()"
desc: "Get name of query parameter that indicates the API Version if versioningScheme is set to \\`query\\`."
returns:
description: "the versionQueryName 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.ApiVersionSetContractDetails.versioningScheme()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.versioningScheme()"
name: "versioningScheme()"
nameWithType: "ApiVersionSetContractDetails.versioningScheme()"
summary: "Get an value that determines where the API Version identifer will be located in a HTTP request."
syntax: "public String versioningScheme()"
desc: "Get an value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'Segment', 'Query', 'Header'."
returns:
description: "the versioningScheme 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.ApiVersionSetContractDetails.withDescription(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withDescription(String description)"
name: "withDescription(String description)"
nameWithType: "ApiVersionSetContractDetails.withDescription(String description)"
summary: "Set description of API Version Set."
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 ApiVersionSetContractDetails withDescription(String description)"
desc: "Set description of API Version Set."
returns:
description: "the ApiVersionSetContractDetails object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails&text=ApiVersionSetContractDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withId(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withId(String id)"
name: "withId(String id)"
nameWithType: "ApiVersionSetContractDetails.withId(String id)"
summary: "Set identifier for existing API Version Set."
parameters:
- description: "the id value to set"
name: "id"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiVersionSetContractDetails withId(String id)"
desc: "Set identifier for existing API Version Set. Omit this value to create a new Version Set."
returns:
description: "the ApiVersionSetContractDetails object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails&text=ApiVersionSetContractDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withName(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withName(String name)"
name: "withName(String name)"
nameWithType: "ApiVersionSetContractDetails.withName(String name)"
summary: "Set the display Name of the API Version Set."
parameters:
- description: "the name value to set"
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiVersionSetContractDetails withName(String name)"
desc: "Set the display Name of the API Version Set."
returns:
description: "the ApiVersionSetContractDetails object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails&text=ApiVersionSetContractDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withVersionHeaderName(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withVersionHeaderName(String versionHeaderName)"
name: "withVersionHeaderName(String versionHeaderName)"
nameWithType: "ApiVersionSetContractDetails.withVersionHeaderName(String versionHeaderName)"
summary: "Set name of HTTP header parameter that indicates the API Version if versioning<wbr>Scheme is set to \\`header\\`."
parameters:
- description: "the versionHeaderName value to set"
name: "versionHeaderName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiVersionSetContractDetails withVersionHeaderName(String versionHeaderName)"
desc: "Set name of HTTP header parameter that indicates the API Version if versioningScheme is set to \\`header\\`."
returns:
description: "the ApiVersionSetContractDetails object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails&text=ApiVersionSetContractDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withVersionQueryName(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withVersionQueryName(String versionQueryName)"
name: "withVersionQueryName(String versionQueryName)"
nameWithType: "ApiVersionSetContractDetails.withVersionQueryName(String versionQueryName)"
summary: "Set name of query parameter that indicates the API Version if versioning<wbr>Scheme is set to \\`query\\`."
parameters:
- description: "the versionQueryName value to set"
name: "versionQueryName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiVersionSetContractDetails withVersionQueryName(String versionQueryName)"
desc: "Set name of query parameter that indicates the API Version if versioningScheme is set to \\`query\\`."
returns:
description: "the ApiVersionSetContractDetails object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails&text=ApiVersionSetContractDetails\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withVersioningScheme(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails.withVersioningScheme(String versioningScheme)"
name: "withVersioningScheme(String versioningScheme)"
nameWithType: "ApiVersionSetContractDetails.withVersioningScheme(String versioningScheme)"
summary: "Set an value that determines where the API Version identifer will be located in a HTTP request."
parameters:
- description: "the versioningScheme value to set"
name: "versioningScheme"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ApiVersionSetContractDetails withVersioningScheme(String versioningScheme)"
desc: "Set an value that determines where the API Version identifer will be located in a HTTP request. Possible values include: 'Segment', 'Query', 'Header'."
returns:
description: "the ApiVersionSetContractDetails object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ApiVersionSetContractDetails&text=ApiVersionSetContractDetails\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "An API Version Set contains the common configuration for a set of API Versions relating."
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