RequestOptions Klasse

Paket:

com.microsoft.azure.storage

• java.lang.Object
• • com.microsoft.azure.storage.RequestOptions

public class RequestOptions

Stellt die Optionen dar, die beim Verarbeiten einer bestimmten Anforderung verwendet werden sollen.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
RequestOptions()	Erstellt eine instance der -Klasse.
RequestOptions(final RequestOptions other)	Erstellt eine instance der -Klasse durch Kopieren von Werten aus einer anderen instance.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
void	applyBaseDefaultsInternal(final RequestOptions modifiedOptions) Füllt das Standardtimeout, die Wiederholungsrichtlinie und den Standortmodus vom Client auf, wenn sie NULL sind.
Boolean	disableHttpsSocketKeepAlive() Ruft einen Wert ab, der angibt, ob https socket keep-alive deaktiviert werden soll. Verwenden Sie, um keep-alive zu deaktivieren; Andernfalls. Weitere Informationen zu disableHttpsSocketKeepAlive-Standardwerten finden Sie unter getDefaultRequestOptions()
final LocationMode	getLocationMode() Ruft den Standardspeicherortmodus für diese Anforderung ab. Weitere Informationen zum Standortmodus finden Sie unter setLocationMode(final LocationMode locationMode).
Integer	getMaximumExecutionTimeInMs() Ruft die maximale Ausführungszeit für diese Anforderung ab. Weitere Informationen zu den Standardwerten für maximale Ausführungszeit finden Sie unter setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs).
Long	getOperationExpiryTimeInMs() RESERVIERT FÜR DEN INTERNEN GEBRAUCH. Gibt den Zeitpunkt zurück, zu dem dieser Vorgang abläuft. Dies wird berechnet, indem die Zeit, zu der der Vorgang beginnt, und die maximale Ausführungszeit hinzugefügt wird, und ist NULL, wenn die maximale Ausführungszeit NULL ist. Weitere Informationen zur maximalen Ausführungszeit finden Sie unter setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs).
final RetryPolicyFactory	getRetryPolicyFactory() Ruft die Wiederholungsrichtlinie ab, die für diese Anforderung verwendet werden soll. Weitere Informationen zu den Standardeinstellungen der Wiederholungsrichtlinie finden Sie unter setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory).
final Integer	getTimeoutIntervalInMs() Gibt den Timeoutwert für diese Anforderung zurück. Weitere Informationen zu den Timeoutstandardeinstellungen finden Sie unter setTimeoutIntervalInMs(final Integer timeoutIntervalInMs).
void	populateRequestOptions(RequestOptions modifiedOptions, final RequestOptions clientOptions, final boolean setStartTime) Füllt alle NULL-Felder im ersten requestOptions-Objekt mit Werten aus dem zweiten requestOptions-Objekt auf.
Boolean	requireEncryption() Ruft einen Wert ab, der angibt, ob alle geschriebenen und gelesenen Daten verschlüsselt werden müssen. Verwenden Sie zum Verschlüsseln/Entschlüsseln von Daten für Transaktionen; Andernfalls. Weitere Informationen zum Erfordern von Verschlüsselungsstandards finden Sie unter setRequireEncryption(Boolean requireEncryption).
void	setDisableHttpsSocketKeepAlive(Boolean disableHttpsSocketKeepAlive) Legt einen Wert fest, der angibt, ob https socket keep-alive deaktiviert werden soll. Verwenden Sie, um keep-alive zu deaktivieren; Andernfalls Der Standardwert wird im Client festgelegt und ist standardmäßig true, was angibt, dass https socket keep-alive deaktiviert wird. Sie können den Wert für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() -Objekt ändern, sodass alle nachfolgenden Anforderungen, die über den Dienstclient erfolgen, den entsprechenden Wert verwenden. Das Festlegen von Keep-Alive für HTTPS-Sockets besteht darin, einen Fehler in der JVM zu umgehen, bei dem Verbindungstimeouts bei wiederholten Anforderungen nicht berücksichtigt werden. In diesen Fällen können Sie socket keep-alive als Fallback verwenden. Leider muss der Timeoutwert einer JVM-Eigenschaft entnommen werden und nicht lokal konfiguriert werden. In seltenen Fällen hat die JVM daher aggressiv kurze Keep-Alive-Zeiten konfiguriert, kann es nicht von Vorteil sein, die Verwendung von Keep-Alives zu ermöglichen, damit sie nicht die lang andauernden Datenübertragungsvorgänge beeinträchtigen.
void	setLocationMode(final LocationMode locationMode) Legt für diese Anforderung fest LocationMode . Der Standardwert LocationMode ist im Client festgelegt und lautet standardmäßig PRIMARY_ONLY. Sie können die LocationMode für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() -Objekt ändern, sodass alle nachfolgenden Anforderungen, die über den Dienstclient gesendet werden, diesen LocationModeverwenden.
void	setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs) Legt die maximale Ausführungszeit fest, die beim Stellen dieser Anforderung verwendet werden soll. Das maximale Ausführungszeitintervall beginnt zu dem Zeitpunkt, zu dem der Client mit dem Erstellen der Anforderung beginnt. Die maximale Ausführungszeit wird zeitweilig beim Hochladen von Daten, beim Herunterladen von Daten und vor der Ausführung von Wiederholungen überprüft. Der Dienst wird weiterhin hochgeladen, heruntergeladen und wiederholt, bis die maximale Ausführungszeit erreicht ist. Zu diesem Zeitpunkt werden alle teilweisen Uploads oder Downloads abgebrochen, und es wird eine Ausnahme ausgelöst. Die maximale Standardausführung wird im Client festgelegt und ist standardmäßig NULL, was keine maximale Zeit angibt. Sie können die maximale Ausführungszeit für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() Objekt ändern, sodass für alle nachfolgenden Anforderungen, die über den Dienstclient ausgeführt werden, die maximale Ausführungszeit verwendet wird.
void	setRequireEncryption(Boolean requireEncryption) Legt einen Wert fest, der angibt, ob alle geschriebenen und gelesenen Daten verschlüsselt werden müssen. Verwenden Sie zum Verschlüsseln/Entschlüsseln von Daten für Transaktionen; Andernfalls. Der Standardwert ist im Client festgelegt und standardmäßig false, was darauf hinweist, dass keine Verschlüsselung erforderlich ist. Sie können den Wert für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() Objekt ändern, sodass alle nachfolgenden Anforderungen über den Dienstclient den entsprechenden Wert verwenden.
final void	setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory) Legt das RetryPolicyFactory-Objekt fest, das für diese Anforderung verwendet werden soll. Die Standardmäßige RetryPolicyFactory wird im Client festgelegt und lautet standardmäßig RetryExponentialRetry. Sie können die RetryPolicyFactory für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() Objekt ändern, sodass alle nachfolgenden Anforderungen, die über den Dienstclient ausgeführt werden, diese RetryPolicyFactory verwenden.
final void	setTimeoutIntervalInMs(final Integer timeoutIntervalInMs) Legt das Timeout fest, das beim Stellen dieser Anforderung verwendet werden soll. Das Servertimeoutintervall beginnt zu dem Zeitpunkt, zu dem die vollständige Anforderung vom Dienst empfangen wurde, und der Server beginnt mit der Verarbeitung der Antwort. Wenn das Timeoutintervall verstreicht, bevor die Antwort an den Client zurückgegeben wird, wird für den Vorgang ein Timeout ausgeführt. Das Timeoutintervall wird bei jedem Wiederholungsversuch zurückgesetzt, wenn die Anforderung wiederholt wird. Das Standard-Servertimeout wird im Client festgelegt und ist standardmäßig NULL, was kein Servertimeout angibt. Sie können das Servertimeout für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() Objekt ändern, sodass für alle nachfolgenden Anforderungen, die über den Dienstclient ausgeführt werden, das Servertimeout verwendet wird.

Details zum Konstruktor

RequestOptions

public RequestOptions()

Erstellt eine instance der -Klasse.

RequestOptions

public RequestOptions(final RequestOptions other)

Erstellt eine instance der -Klasse durch Kopieren von Werten aus einer anderen instance.

Parameters:

other - Ein RequestOptions -Objekt, das die zu kopierenden Anforderungsoptionen darstellt.

Details zur Methode

applyBaseDefaultsInternal

protected static void applyBaseDefaultsInternal(final RequestOptions modifiedOptions)

Füllt das Standardtimeout, die Wiederholungsrichtlinie und den Standortmodus vom Client auf, wenn sie NULL sind.

Parameters:

modifiedOptions - Die Eingabeoptionen, aus der beim Anwenden von Standardwerten kopiert werden soll

disableHttpsSocketKeepAlive

public Boolean disableHttpsSocketKeepAlive()

Ruft einen Wert ab, der angibt, ob https socket keep-alive deaktiviert werden soll. Verwenden Sie, um keep-alive zu deaktivieren; Andernfalls. Weitere Informationen zu disableHttpsSocketKeepAlive-Standardwerten finden Sie unter getDefaultRequestOptions()

Returns:

Ein Wert, der angibt, ob https-Socket keep-alive deaktiviert werden soll.

getLocationMode

public final LocationMode getLocationMode()

Ruft den Standardspeicherortmodus für diese Anforderung ab. Weitere Informationen zum Standortmodus finden Sie unter setLocationMode(final LocationMode locationMode).

Returns:

Ein LocationMode -Objekt, das den Standortmodus für diese Anforderung darstellt.

getMaximumExecutionTimeInMs

public Integer getMaximumExecutionTimeInMs()

Ruft die maximale Ausführungszeit für diese Anforderung ab. Weitere Informationen zu den Standardwerten für maximale Ausführungszeit finden Sie unter setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs).

Returns:

Die aktuelle maximale Ausführungszeit in Millisekunden für diese Anforderung.

getOperationExpiryTimeInMs

public Long getOperationExpiryTimeInMs()

RESERVIERT FÜR DEN INTERNEN GEBRAUCH.

Gibt den Zeitpunkt zurück, zu dem dieser Vorgang abläuft. Dies wird berechnet, indem die Zeit, zu der der Vorgang beginnt, und die maximale Ausführungszeit hinzugefügt wird, und ist NULL, wenn die maximale Ausführungszeit NULL ist. Weitere Informationen zur maximalen Ausführungszeit finden Sie unter setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs).

Returns:

Die aktuelle Vorgangsablaufzeit in Millisekunden für diese Anforderung.

getRetryPolicyFactory

public final RetryPolicyFactory getRetryPolicyFactory()

Ruft die Wiederholungsrichtlinie ab, die für diese Anforderung verwendet werden soll. Weitere Informationen zu den Standardeinstellungen der Wiederholungsrichtlinie finden Sie unter setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory).

Returns:

Ein RetryPolicyFactory -Objekt, das die aktuelle Wiederholungsrichtlinie darstellt.

getTimeoutIntervalInMs

public final Integer getTimeoutIntervalInMs()

Gibt den Timeoutwert für diese Anforderung zurück. Weitere Informationen zu den Timeoutstandardeinstellungen finden Sie unter setTimeoutIntervalInMs(final Integer timeoutIntervalInMs).

Returns:

Der aktuelle Timeoutwert in Millisekunden für diese Anforderung.

populateRequestOptions

protected static void populateRequestOptions(RequestOptions modifiedOptions, final RequestOptions clientOptions, final boolean setStartTime)

Füllt alle NULL-Felder im ersten requestOptions-Objekt mit Werten aus dem zweiten requestOptions-Objekt auf.

Parameters:

modifiedOptions

clientOptions

setStartTime

requireEncryption

public Boolean requireEncryption()

Ruft einen Wert ab, der angibt, ob alle geschriebenen und gelesenen Daten verschlüsselt werden müssen. Verwenden Sie zum Verschlüsseln/Entschlüsseln von Daten für Transaktionen; Andernfalls. Weitere Informationen zum Erfordern von Verschlüsselungsstandards finden Sie unter setRequireEncryption(Boolean requireEncryption).

Returns:

Ein Wert, der angibt, ob alle geschriebenen und gelesenen Daten verschlüsselt werden müssen.

setDisableHttpsSocketKeepAlive

public void setDisableHttpsSocketKeepAlive(Boolean disableHttpsSocketKeepAlive)

Legt einen Wert fest, der angibt, ob https socket keep-alive deaktiviert werden soll. Verwenden Sie, um keep-alive zu deaktivieren; Andernfalls

Der Standardwert wird im Client festgelegt und ist standardmäßig true, was angibt, dass https socket keep-alive deaktiviert wird. Sie können den Wert für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() -Objekt ändern, sodass alle nachfolgenden Anforderungen, die über den Dienstclient erfolgen, den entsprechenden Wert verwenden.

Das Festlegen von Keep-Alive für HTTPS-Sockets besteht darin, einen Fehler in der JVM zu umgehen, bei dem Verbindungstimeouts bei wiederholten Anforderungen nicht berücksichtigt werden. In diesen Fällen können Sie socket keep-alive als Fallback verwenden. Leider muss der Timeoutwert einer JVM-Eigenschaft entnommen werden und nicht lokal konfiguriert werden. In seltenen Fällen hat die JVM daher aggressiv kurze Keep-Alive-Zeiten konfiguriert, kann es nicht von Vorteil sein, die Verwendung von Keep-Alives zu ermöglichen, damit sie nicht die lang andauernden Datenübertragungsvorgänge beeinträchtigen.

Parameters:

disableHttpsSocketKeepAlive - Ein Wert, der angibt, ob https-Socket keep-alive deaktiviert werden soll.

setLocationMode

public void setLocationMode(final LocationMode locationMode)

Legt für diese Anforderung fest LocationMode .

Der Standardwert LocationMode ist im Client festgelegt und lautet standardmäßig PRIMARY_ONLY. Sie können die LocationMode für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() -Objekt ändern, sodass alle nachfolgenden Anforderungen, die über den Dienstclient gesendet werden, diesen LocationModeverwenden.

Parameters:

locationMode - der festzulegende locationMode

setMaximumExecutionTimeInMs

public void setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)

Legt die maximale Ausführungszeit fest, die beim Stellen dieser Anforderung verwendet werden soll.

Das maximale Ausführungszeitintervall beginnt zu dem Zeitpunkt, zu dem der Client mit dem Erstellen der Anforderung beginnt. Die maximale Ausführungszeit wird zeitweilig beim Hochladen von Daten, beim Herunterladen von Daten und vor der Ausführung von Wiederholungen überprüft. Der Dienst wird weiterhin hochgeladen, heruntergeladen und wiederholt, bis die maximale Ausführungszeit erreicht ist. Zu diesem Zeitpunkt werden alle teilweisen Uploads oder Downloads abgebrochen, und es wird eine Ausnahme ausgelöst.

Die maximale Standardausführung wird im Client festgelegt und ist standardmäßig NULL, was keine maximale Zeit angibt. Sie können die maximale Ausführungszeit für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() Objekt ändern, sodass für alle nachfolgenden Anforderungen, die über den Dienstclient ausgeführt werden, die maximale Ausführungszeit verwendet wird.

Parameters:

maximumExecutionTimeInMs - Die maximale Ausführungszeit in Millisekunden, die für diese Anforderung verwendet werden soll.

setRequireEncryption

public void setRequireEncryption(Boolean requireEncryption)

Legt einen Wert fest, der angibt, ob alle geschriebenen und gelesenen Daten verschlüsselt werden müssen. Verwenden Sie zum Verschlüsseln/Entschlüsseln von Daten für Transaktionen; Andernfalls.

Der Standardwert ist im Client festgelegt und standardmäßig false, was darauf hinweist, dass keine Verschlüsselung erforderlich ist. Sie können den Wert für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() Objekt ändern, sodass alle nachfolgenden Anforderungen über den Dienstclient den entsprechenden Wert verwenden.

Parameters:

requireEncryption - Ein Wert, der angibt, ob alle geschriebenen und gelesenen Daten verschlüsselt werden müssen.

setRetryPolicyFactory

public final void setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory)

Legt das RetryPolicyFactory-Objekt fest, das für diese Anforderung verwendet werden soll.

Die Standardmäßige RetryPolicyFactory wird im Client festgelegt und lautet standardmäßig RetryExponentialRetry. Sie können die RetryPolicyFactory für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() Objekt ändern, sodass alle nachfolgenden Anforderungen, die über den Dienstclient ausgeführt werden, diese RetryPolicyFactory verwenden.

Parameters:

retryPolicyFactory - das RetryPolicyFactory-Objekt, das beim Erstellen von Dienstanforderungen verwendet werden soll.

setTimeoutIntervalInMs

public final void setTimeoutIntervalInMs(final Integer timeoutIntervalInMs)

Legt das Timeout fest, das beim Stellen dieser Anforderung verwendet werden soll.

Das Servertimeoutintervall beginnt zu dem Zeitpunkt, zu dem die vollständige Anforderung vom Dienst empfangen wurde, und der Server beginnt mit der Verarbeitung der Antwort. Wenn das Timeoutintervall verstreicht, bevor die Antwort an den Client zurückgegeben wird, wird für den Vorgang ein Timeout ausgeführt. Das Timeoutintervall wird bei jedem Wiederholungsversuch zurückgesetzt, wenn die Anforderung wiederholt wird.

Das Standard-Servertimeout wird im Client festgelegt und ist standardmäßig NULL, was kein Servertimeout angibt. Sie können das Servertimeout für diese Anforderung ändern, indem Sie diese Eigenschaft festlegen. Sie können auch den Wert für das getDefaultRequestOptions() Objekt ändern, sodass für alle nachfolgenden Anforderungen, die über den Dienstclient ausgeführt werden, das Servertimeout verwendet wird.

Parameters:

timeoutIntervalInMs - Das Timeout in Millisekunden, das für diese Anforderung verwendet werden soll.