ApiContractUpdateProperties Klasse

Paket:

com.azure.resourcemanager.apimanagement.fluent.models

Maven-Artefakt:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

• java.lang.Object
• • com.azure.resourcemanager.apimanagement.models.ApiEntityBaseContract
  • • com.azure.resourcemanager.apimanagement.fluent.models.ApiContractUpdateProperties

public final class ApiContractUpdateProperties
extends ApiEntityBaseContract

API-Vertragseigenschaften aktualisieren.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
ApiContractUpdateProperties()	Erstellt eine instance der Api ContractUpdateProperties-Klasse.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
String	displayName() Rufen Sie die displayName-Eigenschaft ab: API-Name.
String	path() Abrufen der Path-Eigenschaft: Relative URL, die diese API und alle Ressourcenpfade innerhalb des API Management Diensts eindeutig identifiziert instance.
List<Protocol>	protocols() Protokolleigenschaft abrufen: Beschreibt, für welche Protokolle die Vorgänge in dieser API aufgerufen werden können.
String	serviceUrl() Rufen Sie die Dienst-URL-Eigenschaftab: Absolute URL des Back-End-Diensts, der diese API implementiert.
void	validate() Überprüft die instance.
ApiContractUpdateProperties	withApiRevision(String apiRevision) Festlegen der api Revision-Eigenschaft: Beschreibt die Überarbeitung der API.
ApiContractUpdateProperties	withApiRevisionDescription(String apiRevisionDescription) Legen Sie die API RevisionDescription-Eigenschaft fest: Beschreibung der API-Revision.
ApiContractUpdateProperties	withApiType(ApiType apiType) Legen Sie die api Type-Eigenschaftfest: Typ der API.
ApiContractUpdateProperties	withApiVersion(String apiVersion) Festlegen der api Version-Eigenschaft: Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.
ApiContractUpdateProperties	withApiVersionDescription(String apiVersionDescription) Legen Sie die API VersionDescription-Eigenschaftfest: Beschreibung der API-Version.
ApiContractUpdateProperties	withApiVersionSetId(String apiVersionSetId) Legen Sie die Api VersionSet ID-Eigenschaft fest: Ein Ressourcenbezeichner für den zugehörigen Api-Versionssatz.
ApiContractUpdateProperties	withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings) Legen Sie die Authentifizierungseinstellungen-Eigenschaftfest: Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.
ApiContractUpdateProperties	withContact(ApiContactInformation contact) Legen Sie die Contact-Eigenschaft fest: Kontaktinformationen für die API.
ApiContractUpdateProperties	withDescription(String description) Legen Sie die description-Eigenschaft fest: Beschreibung der API.
ApiContractUpdateProperties	withDisplayName(String displayName) Legen Sie die Anzeigename-Eigenschaftfest: API-Name.
ApiContractUpdateProperties	withIsCurrent(Boolean isCurrent) Legen Sie die Eigenschaft currentfest: Gibt an, ob die API-Revision die aktuelle API-Revision ist.
ApiContractUpdateProperties	withLicense(ApiLicenseInformation license) Legen Sie die Lizenzeigenschaft fest: Lizenzinformationen für die API.
ApiContractUpdateProperties	withPath(String path) Legen Sie die Path-Eigenschaft fest: Relative URL, die diese API und alle ressourcenpfade innerhalb des API Management-Diensts eindeutig identifiziert instance.
ApiContractUpdateProperties	withProtocols(List<Protocol> protocols) Festlegen der Protocols-Eigenschaft: Beschreibt, für welche Protokolle die Vorgänge in dieser API aufgerufen werden können.
ApiContractUpdateProperties	withServiceUrl(String serviceUrl) Legen Sie die Dienst-URL-Eigenschaftfest: Absolute URL des Back-End-Diensts, der diese API implementiert.
ApiContractUpdateProperties	withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames) Legen Sie die Eigenschaft Schlüsselparameternamendes Abonnementsfest: Protokolle, über die die API verfügbar gemacht wird.
ApiContractUpdateProperties	withSubscriptionRequired(Boolean subscriptionRequired) Festlegen der Eigenschaft "Abonnementerforderlich": Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.
ApiContractUpdateProperties	withTermsOfServiceUrl(String termsOfServiceUrl) Legen Sie die TermsOfServiceUrl-Eigenschaft fest: Eine URL zu den Nutzungsbedingungen für die API.

Geerbte Methoden von ApiEntityBaseContract

apiRevision apiRevisionDescription apiType apiVersion apiVersionDescription apiVersionSetId authenticationSettings contact description isCurrent isOnline license subscriptionKeyParameterNames subscriptionRequired termsOfServiceUrl validate withApiRevision withApiRevisionDescription withApiType withApiVersion withApiVersionDescription withApiVersionSetId withAuthenticationSettings withContact withDescription withIsCurrent withLicense withSubscriptionKeyParameterNames withSubscriptionRequired withTermsOfServiceUrl

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

ApiContractUpdateProperties

public ApiContractUpdateProperties()

Erstellt eine instance der ApiContractUpdateProperties-Klasse.

Details zur Methode

displayName

public String displayName()

Rufen Sie die displayName-Eigenschaft ab: API-Name.

Returns:

der wert displayName.

path

public String path()

Abrufen der Path-Eigenschaft: Relative URL, die diese API und alle Ressourcenpfade innerhalb des API Management Diensts eindeutig identifiziert instance. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.

Returns:

der Pfadwert.

protocols

public List protocols()

Protokolleigenschaft abrufen: Beschreibt, für welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

Returns:

der Protokollwert.

serviceUrl

public String serviceUrl()

Rufen Sie die serviceUrl-Eigenschaft ab: Absolute URL des Back-End-Diensts, der diese API implementiert.

Returns:

der serviceUrl-Wert.

validate

public void validate()

Überprüft die instance.

Overrides:

ApiContractUpdateProperties.validate()

withApiRevision

public ApiContractUpdateProperties withApiRevision(String apiRevision)

Festlegen der apiRevision-Eigenschaft: Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.

Overrides:

ApiContractUpdateProperties.withApiRevision(String apiRevision)

Parameters:

apiRevision

withApiRevisionDescription

public ApiContractUpdateProperties withApiRevisionDescription(String apiRevisionDescription)

Legen Sie die apiRevisionDescription-Eigenschaft fest: Beschreibung der API-Revision.

Overrides:

ApiContractUpdateProperties.withApiRevisionDescription(String apiRevisionDescription)

Parameters:

apiRevisionDescription

withApiType

public ApiContractUpdateProperties withApiType(ApiType apiType)

Legen Sie die apiType-Eigenschaft fest: Typ der API.

Overrides:

ApiContractUpdateProperties.withApiType(ApiType apiType)

Parameters:

apiType

withApiVersion

public ApiContractUpdateProperties withApiVersion(String apiVersion)

Festlegen der apiVersion-Eigenschaft: Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.

Overrides:

ApiContractUpdateProperties.withApiVersion(String apiVersion)

Parameters:

apiVersion

withApiVersionDescription

public ApiContractUpdateProperties withApiVersionDescription(String apiVersionDescription)

Legen Sie die apiVersionDescription-Eigenschaft fest: Beschreibung der API-Version.

Overrides:

ApiContractUpdateProperties.withApiVersionDescription(String apiVersionDescription)

Parameters:

apiVersionDescription

withApiVersionSetId

public ApiContractUpdateProperties withApiVersionSetId(String apiVersionSetId)

Legen Sie die apiVersionSetId-Eigenschaft fest: Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

Overrides:

ApiContractUpdateProperties.withApiVersionSetId(String apiVersionSetId)

Parameters:

apiVersionSetId

withAuthenticationSettings

public ApiContractUpdateProperties withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)

Legen Sie die authenticationSettings-Eigenschaft fest: Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.

Overrides:

ApiContractUpdateProperties.withAuthenticationSettings(AuthenticationSettingsContract authenticationSettings)

Parameters:

authenticationSettings

withContact

public ApiContractUpdateProperties withContact(ApiContactInformation contact)

Legen Sie die Contact-Eigenschaft fest: Kontaktinformationen für die API.

Overrides:

ApiContractUpdateProperties.withContact(ApiContactInformation contact)

Parameters:

contact

withDescription

public ApiContractUpdateProperties withDescription(String description)

Legen Sie die description-Eigenschaft fest: Beschreibung der API. Kann HTML-Formatierungstags umfassen.

Overrides:

ApiContractUpdateProperties.withDescription(String description)

Parameters:

description

withDisplayName

public ApiContractUpdateProperties withDisplayName(String displayName)

Legen Sie die displayName-Eigenschaft fest: API-Name.

Parameters:

displayName - der festzulegende displayName-Wert.

Returns:

das ApiContractUpdateProperties-Objekt selbst.

withIsCurrent

public ApiContractUpdateProperties withIsCurrent(Boolean isCurrent)

Festlegen der isCurrent-Eigenschaft: Gibt an, ob die API-Revision die aktuelle API-Revision ist.

Overrides:

ApiContractUpdateProperties.withIsCurrent(Boolean isCurrent)

Parameters:

isCurrent

withLicense

public ApiContractUpdateProperties withLicense(ApiLicenseInformation license)

Legen Sie die Lizenzeigenschaft fest: Lizenzinformationen für die API.

Overrides:

ApiContractUpdateProperties.withLicense(ApiLicenseInformation license)

Parameters:

license

withPath

public ApiContractUpdateProperties withPath(String path)

Legen Sie die Path-Eigenschaft fest: Relative URL, die diese API und alle ressourcenpfade innerhalb des API Management-Diensts eindeutig identifiziert instance. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.

Parameters:

path - der festzulegende Pfadwert.

Returns:

das ApiContractUpdateProperties-Objekt selbst.

withProtocols

public ApiContractUpdateProperties withProtocols(List protocols)

Festlegen der Protocols-Eigenschaft: Beschreibt, für welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

Parameters:

protocols - der festzulegende Protokollwert.

Returns:

das ApiContractUpdateProperties-Objekt selbst.

withServiceUrl

public ApiContractUpdateProperties withServiceUrl(String serviceUrl)

Legen Sie die serviceUrl-Eigenschaft fest: Absolute URL des Back-End-Diensts, der diese API implementiert.

Parameters:

serviceUrl - der festzulegende serviceUrl-Wert.

Returns:

das ApiContractUpdateProperties-Objekt selbst.

withSubscriptionKeyParameterNames

public ApiContractUpdateProperties withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

Legen Sie die subscriptionKeyParameterNames-Eigenschaft fest: Protokolle, über die die API verfügbar gemacht wird.

Overrides:

ApiContractUpdateProperties.withSubscriptionKeyParameterNames(SubscriptionKeyParameterNamesContract subscriptionKeyParameterNames)

Parameters:

subscriptionKeyParameterNames

withSubscriptionRequired

public ApiContractUpdateProperties withSubscriptionRequired(Boolean subscriptionRequired)

Festlegen der subscriptionRequired-Eigenschaft: Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.

Overrides:

ApiContractUpdateProperties.withSubscriptionRequired(Boolean subscriptionRequired)

Parameters:

subscriptionRequired

withTermsOfServiceUrl

public ApiContractUpdateProperties withTermsOfServiceUrl(String termsOfServiceUrl)

Legen Sie die termsOfServiceUrl-Eigenschaft fest: Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

Overrides:

ApiContractUpdateProperties.withTermsOfServiceUrl(String termsOfServiceUrl)

Parameters:

termsOfServiceUrl