141 строка
12 KiB
YAML
141 строка
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.test.policy.TestProxyRecordPolicy"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy"
|
|
name: "TestProxyRecordPolicy"
|
|
nameWithType: "TestProxyRecordPolicy"
|
|
summary: "A <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> for redirecting traffic through the test proxy for recording."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **TestProxyRecordPolicy**</br> implements <xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.TestProxyRecordPolicy(com.azure.core.http.HttpClient,boolean)"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.TestProxyRecordPolicy(HttpClient httpClient, boolean skipRecordingRequestBody)"
|
|
name: "TestProxyRecordPolicy(HttpClient httpClient, boolean skipRecordingRequestBody)"
|
|
nameWithType: "TestProxyRecordPolicy.TestProxyRecordPolicy(HttpClient httpClient, boolean skipRecordingRequestBody)"
|
|
summary: "Create an instance of <xref uid=\"com.azure.core.test.policy.TestProxyRecordPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestProxyRecordPolicy\"></xref> with a list of custom sanitizers."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use. If none is passed <xref uid=\"com.azure.core.test.utils.HttpURLConnectionHttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpURLConnectionHttpClient\"></xref> is the default."
|
|
name: "httpClient"
|
|
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Flag indicating to skip recording request bodies when tests run in Record mode."
|
|
name: "skipRecordingRequestBody"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public TestProxyRecordPolicy(HttpClient httpClient, boolean skipRecordingRequestBody)"
|
|
desc: "Create an instance of <xref uid=\"com.azure.core.test.policy.TestProxyRecordPolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestProxyRecordPolicy\"></xref> with a list of custom sanitizers."
|
|
fields:
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.RECORD_MODE"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.RECORD_MODE"
|
|
name: "RECORD_MODE"
|
|
nameWithType: "TestProxyRecordPolicy.RECORD_MODE"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "record"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static final String RECORD_MODE"
|
|
methods:
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.addProxySanitization(java.util.List<com.azure.core.test.models.TestProxySanitizer>)"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.addProxySanitization(List<TestProxySanitizer> sanitizers)"
|
|
name: "addProxySanitization(List<TestProxySanitizer> sanitizers)"
|
|
nameWithType: "TestProxyRecordPolicy.addProxySanitization(List<TestProxySanitizer> sanitizers)"
|
|
summary: "Add a list of <xref uid=\"com.azure.core.test.models.TestProxySanitizer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestProxySanitizer\"></xref> to the current recording session."
|
|
parameters:
|
|
- description: "The sanitizers to add."
|
|
name: "sanitizers"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.core.test.models.TestProxySanitizer?alt=com.azure.core.test.models.TestProxySanitizer&text=TestProxySanitizer\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void addProxySanitization(List<TestProxySanitizer> sanitizers)"
|
|
desc: "Add a list of <xref uid=\"com.azure.core.test.models.TestProxySanitizer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TestProxySanitizer\"></xref> to the current recording session."
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.process(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpPipelineNextPolicy)"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
|
|
name: "process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
|
|
nameWithType: "TestProxyRecordPolicy.process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
|
|
parameters:
|
|
- name: "context"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineCallContext?alt=com.azure.core.http.HttpPipelineCallContext&text=HttpPipelineCallContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "next"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineNextPolicy?alt=com.azure.core.http.HttpPipelineNextPolicy&text=HttpPipelineNextPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<HttpResponse> process(HttpPipelineCallContext context, HttpPipelineNextPolicy next)"
|
|
returns:
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.processSync(com.azure.core.http.HttpPipelineCallContext,com.azure.core.http.HttpPipelineNextSyncPolicy)"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
|
|
name: "processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
|
|
nameWithType: "TestProxyRecordPolicy.processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
|
|
parameters:
|
|
- name: "context"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineCallContext?alt=com.azure.core.http.HttpPipelineCallContext&text=HttpPipelineCallContext\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "next"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineNextSyncPolicy?alt=com.azure.core.http.HttpPipelineNextSyncPolicy&text=HttpPipelineNextSyncPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HttpResponse processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.removeProxySanitization(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.removeProxySanitization(List<String> sanitizers)"
|
|
name: "removeProxySanitization(List<String> sanitizers)"
|
|
nameWithType: "TestProxyRecordPolicy.removeProxySanitization(List<String> sanitizers)"
|
|
summary: "Removes the list of sanitizers from the current playback session."
|
|
parameters:
|
|
- description: "The sanitizers to remove."
|
|
name: "sanitizers"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public void removeProxySanitization(List<String> sanitizers)"
|
|
desc: "Removes the list of sanitizers from the current playback session."
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.setRecordingOptions(com.azure.core.test.models.TestProxyRecordingOptions)"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.setRecordingOptions(TestProxyRecordingOptions testProxyRecordingOptions)"
|
|
name: "setRecordingOptions(TestProxyRecordingOptions testProxyRecordingOptions)"
|
|
nameWithType: "TestProxyRecordPolicy.setRecordingOptions(TestProxyRecordingOptions testProxyRecordingOptions)"
|
|
summary: "Set transport layer test proxy recording options"
|
|
parameters:
|
|
- description: "the transport layer test proxy recording options to set"
|
|
name: "testProxyRecordingOptions"
|
|
type: "<xref href=\"com.azure.core.test.models.TestProxyRecordingOptions?alt=com.azure.core.test.models.TestProxyRecordingOptions&text=TestProxyRecordingOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setRecordingOptions(TestProxyRecordingOptions testProxyRecordingOptions)"
|
|
desc: "Set transport layer test proxy recording options"
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.startRecording(java.io.File,java.nio.file.Path)"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.startRecording(File recordFile, Path testClassPath)"
|
|
name: "startRecording(File recordFile, Path testClassPath)"
|
|
nameWithType: "TestProxyRecordPolicy.startRecording(File recordFile, Path testClassPath)"
|
|
summary: "Starts a recording of test traffic."
|
|
parameters:
|
|
- description: "The name of the file to save the recording to."
|
|
name: "recordFile"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/File.html\">File</a>"
|
|
- description: "the test class path"
|
|
name: "testClassPath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/file/Path.html\">Path</a>"
|
|
syntax: "public void startRecording(File recordFile, Path testClassPath)"
|
|
desc: "Starts a recording of test traffic."
|
|
- uid: "com.azure.core.test.policy.TestProxyRecordPolicy.stopRecording(java.util.Queue<java.lang.String>)"
|
|
fullName: "com.azure.core.test.policy.TestProxyRecordPolicy.stopRecording(Queue<String> variables)"
|
|
name: "stopRecording(Queue<String> variables)"
|
|
nameWithType: "TestProxyRecordPolicy.stopRecording(Queue<String> variables)"
|
|
summary: "Stops recording of test traffic."
|
|
parameters:
|
|
- description: "A list of random variables generated during the test which is saved in the recording."
|
|
name: "variables"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Queue.html\">Queue</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public void stopRecording(Queue<String> variables)"
|
|
desc: "Stops recording of test traffic."
|
|
type: "class"
|
|
desc: "A <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicy\"></xref> for redirecting traffic through the test proxy for recording."
|
|
implements:
|
|
- "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.azure.core.test.policy"
|
|
artifact: com.azure:azure-core-test:1.26.2
|