116 строки
12 KiB
YAML
116 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.http.rest.StreamResponse"
|
|
fullName: "com.azure.core.http.rest.StreamResponse"
|
|
name: "StreamResponse"
|
|
nameWithType: "StreamResponse"
|
|
summary: "This class represents a REST response with a streaming content."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.http.rest.SimpleResponse?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.core.http.rest.SimpleResponse?alt=com.azure.core.http.rest.SimpleResponse&text=SimpleResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.core.http.rest.SimpleResponse.getHeaders()?alt=com.azure.core.http.rest.SimpleResponse.getHeaders&text=getHeaders\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.http.rest.SimpleResponse.getRequest()?alt=com.azure.core.http.rest.SimpleResponse.getRequest&text=getRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.http.rest.SimpleResponse.getStatusCode()?alt=com.azure.core.http.rest.SimpleResponse.getStatusCode&text=getStatusCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.http.rest.SimpleResponse.getValue()?alt=com.azure.core.http.rest.SimpleResponse.getValue&text=getValue\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 final class **StreamResponse**</br> extends <xref href=\"com.azure.core.http.rest.SimpleResponse?alt=com.azure.core.http.rest.SimpleResponse&text=SimpleResponse\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html\">Flux</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html\">ByteBuffer</a>>></br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html\">Closeable</a>"
|
|
constructors:
|
|
- uid: "com.azure.core.http.rest.StreamResponse.StreamResponse(com.azure.core.http.HttpRequest,int,com.azure.core.http.HttpHeaders,reactor.core.publisher.Flux<java.nio.ByteBuffer>)"
|
|
fullName: "com.azure.core.http.rest.StreamResponse.StreamResponse(HttpRequest request, int statusCode, HttpHeaders headers, Flux<ByteBuffer> value)"
|
|
name: "StreamResponse(HttpRequest request, int statusCode, HttpHeaders headers, Flux<ByteBuffer> value)"
|
|
nameWithType: "StreamResponse.StreamResponse(HttpRequest request, int statusCode, HttpHeaders headers, Flux<ByteBuffer> value)"
|
|
summary: "Creates a <xref uid=\"com.azure.core.http.rest.StreamResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StreamResponse\"></xref>."
|
|
deprecatedTag: "Use <xref uid=\"com.azure.core.http.rest.StreamResponse.StreamResponse(com.azure.core.http.HttpResponse)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#StreamResponse(HttpResponse)\"></xref>"
|
|
parameters:
|
|
- description: "The request which resulted in this response."
|
|
name: "request"
|
|
type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The status code of the HTTP response."
|
|
name: "statusCode"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The headers of the HTTP response."
|
|
name: "headers"
|
|
type: "<xref href=\"com.azure.core.http.HttpHeaders?alt=com.azure.core.http.HttpHeaders&text=HttpHeaders\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The content of the HTTP response."
|
|
name: "value"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html\">Flux</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html\">ByteBuffer</a>>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public StreamResponse(HttpRequest request, int statusCode, HttpHeaders headers, Flux<ByteBuffer> value)"
|
|
desc: "Creates a <xref uid=\"com.azure.core.http.rest.StreamResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StreamResponse\"></xref>."
|
|
hasDeprecatedTag: true
|
|
- uid: "com.azure.core.http.rest.StreamResponse.StreamResponse(com.azure.core.http.HttpResponse)"
|
|
fullName: "com.azure.core.http.rest.StreamResponse.StreamResponse(HttpResponse response)"
|
|
name: "StreamResponse(HttpResponse response)"
|
|
nameWithType: "StreamResponse.StreamResponse(HttpResponse response)"
|
|
summary: "Creates a <xref uid=\"com.azure.core.http.rest.StreamResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StreamResponse\"></xref>."
|
|
parameters:
|
|
- description: "The HTTP response."
|
|
name: "response"
|
|
type: "<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public StreamResponse(HttpResponse response)"
|
|
desc: "Creates a <xref uid=\"com.azure.core.http.rest.StreamResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StreamResponse\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.core.http.rest.StreamResponse.close()"
|
|
fullName: "com.azure.core.http.rest.StreamResponse.close()"
|
|
name: "close()"
|
|
nameWithType: "StreamResponse.close()"
|
|
summary: "Disposes the connection associated with this <xref uid=\"com.azure.core.http.rest.StreamResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StreamResponse\"></xref>."
|
|
syntax: "public void close()"
|
|
desc: "Disposes the connection associated with this <xref uid=\"com.azure.core.http.rest.StreamResponse\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StreamResponse\"></xref>."
|
|
- uid: "com.azure.core.http.rest.StreamResponse.getValue()"
|
|
fullName: "com.azure.core.http.rest.StreamResponse.getValue()"
|
|
name: "getValue()"
|
|
nameWithType: "StreamResponse.getValue()"
|
|
summary: "The content of the HTTP response as a stream of <xref uid=\"java.nio.ByteBuffer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"byte buffers\"></xref>."
|
|
overridden: "com.azure.core.http.rest.SimpleResponse.getValue()"
|
|
syntax: "public Flux<ByteBuffer> getValue()"
|
|
desc: "The content of the HTTP response as a stream of <xref uid=\"java.nio.ByteBuffer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"byte buffers\"></xref>."
|
|
returns:
|
|
description: "The content of the HTTP response as a stream of <xref uid=\"java.nio.ByteBuffer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"byte buffers\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html\">Flux</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html\">ByteBuffer</a>>"
|
|
- uid: "com.azure.core.http.rest.StreamResponse.writeValueTo(java.nio.channels.WritableByteChannel)"
|
|
fullName: "com.azure.core.http.rest.StreamResponse.writeValueTo(WritableByteChannel channel)"
|
|
name: "writeValueTo(WritableByteChannel channel)"
|
|
nameWithType: "StreamResponse.writeValueTo(WritableByteChannel channel)"
|
|
summary: "Transfers content bytes to the <xref uid=\"java.nio.channels.WritableByteChannel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WritableByteChannel\"></xref>."
|
|
parameters:
|
|
- description: "The destination <xref uid=\"java.nio.channels.WritableByteChannel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WritableByteChannel\"></xref>."
|
|
name: "channel"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/channels/WritableByteChannel.html\">WritableByteChannel</a>"
|
|
syntax: "public void writeValueTo(WritableByteChannel channel)"
|
|
desc: "Transfers content bytes to the <xref uid=\"java.nio.channels.WritableByteChannel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WritableByteChannel\"></xref>."
|
|
- uid: "com.azure.core.http.rest.StreamResponse.writeValueToAsync(java.nio.channels.AsynchronousByteChannel)"
|
|
fullName: "com.azure.core.http.rest.StreamResponse.writeValueToAsync(AsynchronousByteChannel channel)"
|
|
name: "writeValueToAsync(AsynchronousByteChannel channel)"
|
|
nameWithType: "StreamResponse.writeValueToAsync(AsynchronousByteChannel channel)"
|
|
summary: "Transfers content bytes to the <xref uid=\"java.nio.channels.AsynchronousByteChannel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AsynchronousByteChannel\"></xref>."
|
|
parameters:
|
|
- description: "The destination <xref uid=\"java.nio.channels.AsynchronousByteChannel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AsynchronousByteChannel\"></xref>."
|
|
name: "channel"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/channels/AsynchronousByteChannel.html\">AsynchronousByteChannel</a>"
|
|
syntax: "public Mono<Void> writeValueToAsync(AsynchronousByteChannel channel)"
|
|
desc: "Transfers content bytes to the <xref uid=\"java.nio.channels.AsynchronousByteChannel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AsynchronousByteChannel\"></xref>."
|
|
returns:
|
|
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when transfer is completed."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
type: "class"
|
|
desc: "This class represents a REST response with a streaming content. It encapsulates the HTTP request that resulted in the response, the status code of the HTTP response, the headers of the HTTP response, and the content of the HTTP response as a stream of <xref uid=\"java.nio.ByteBuffer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"byte buffers\"></xref>.\n\nIt also provides methods to write the content of the HTTP response to a <xref uid=\"java.nio.channels.AsynchronousByteChannel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AsynchronousByteChannel\"></xref> or a <xref uid=\"java.nio.channels.WritableByteChannel\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WritableByteChannel\"></xref>, and to dispose the connection associated with the response."
|
|
implements:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html\">Closeable</a>"
|
|
metadata: {}
|
|
package: "com.azure.core.http.rest"
|
|
artifact: com.azure:azure-core:1.52.0
|