Files
dart-core-sdk/lib/google/api/httpbody.pb.dart
2026-01-16 10:20:10 +00:00

135 lines
5.0 KiB
Dart

// This is a generated file - do not edit.
//
// Generated from google/api/httpbody.proto.
// @dart = 3.3
// ignore_for_file: annotate_overrides, camel_case_types, comment_references
// ignore_for_file: constant_identifier_names
// ignore_for_file: curly_braces_in_flow_control_structures
// ignore_for_file: deprecated_member_use_from_same_package, library_prefixes
// ignore_for_file: non_constant_identifier_names
import 'dart:core' as $core;
import 'package:protobuf/protobuf.dart' as $pb;
import '../protobuf/any.pb.dart' as $0;
export 'package:protobuf/protobuf.dart' show GeneratedMessageGenericExtensions;
/// Message that represents an arbitrary HTTP body. It should only be used for
/// payload formats that can't be represented as JSON, such as raw binary or
/// an HTML page.
///
///
/// This message can be used both in streaming and non-streaming API methods in
/// the request as well as the response.
///
/// It can be used as a top-level request field, which is convenient if one
/// wants to extract parameters from either the URL or HTTP template into the
/// request fields and also want access to the raw HTTP body.
///
/// Example:
///
/// message GetResourceRequest {
/// // A unique request id.
/// string request_id = 1;
///
/// // The raw HTTP body is bound to this field.
/// google.api.HttpBody http_body = 2;
///
/// }
///
/// service ResourceService {
/// rpc GetResource(GetResourceRequest)
/// returns (google.api.HttpBody);
/// rpc UpdateResource(google.api.HttpBody)
/// returns (google.protobuf.Empty);
///
/// }
///
/// Example with streaming methods:
///
/// service CaldavService {
/// rpc GetCalendar(stream google.api.HttpBody)
/// returns (stream google.api.HttpBody);
/// rpc UpdateCalendar(stream google.api.HttpBody)
/// returns (stream google.api.HttpBody);
///
/// }
///
/// Use of this type only changes how the request and response bodies are
/// handled, all other features will continue to work unchanged.
class HttpBody extends $pb.GeneratedMessage {
factory HttpBody({
$core.String? contentType,
$core.List<$core.int>? data,
$core.Iterable<$0.Any>? extensions,
}) {
final result = create();
if (contentType != null) result.contentType = contentType;
if (data != null) result.data = data;
if (extensions != null) result.extensions.addAll(extensions);
return result;
}
HttpBody._();
factory HttpBody.fromBuffer($core.List<$core.int> data, [$pb.ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) => create()..mergeFromBuffer(data, registry);
factory HttpBody.fromJson($core.String json, [$pb.ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) => create()..mergeFromJson(json, registry);
static final $pb.BuilderInfo _i = $pb.BuilderInfo(_omitMessageNames ? '' : 'HttpBody', package: const $pb.PackageName(_omitMessageNames ? '' : 'google.api'), createEmptyInstance: create)
..aOS(1, _omitFieldNames ? '' : 'contentType')
..a<$core.List<$core.int>>(2, _omitFieldNames ? '' : 'data', $pb.PbFieldType.OY)
..pc<$0.Any>(3, _omitFieldNames ? '' : 'extensions', $pb.PbFieldType.PM, subBuilder: $0.Any.create)
..hasRequiredFields = false
;
@$core.Deprecated('See https://github.com/google/protobuf.dart/issues/998.')
HttpBody clone() => HttpBody()..mergeFromMessage(this);
@$core.Deprecated('See https://github.com/google/protobuf.dart/issues/998.')
HttpBody copyWith(void Function(HttpBody) updates) => super.copyWith((message) => updates(message as HttpBody)) as HttpBody;
@$core.override
$pb.BuilderInfo get info_ => _i;
@$core.pragma('dart2js:noInline')
static HttpBody create() => HttpBody._();
@$core.override
HttpBody createEmptyInstance() => create();
static $pb.PbList<HttpBody> createRepeated() => $pb.PbList<HttpBody>();
@$core.pragma('dart2js:noInline')
static HttpBody getDefault() => _defaultInstance ??= $pb.GeneratedMessage.$_defaultFor<HttpBody>(create);
static HttpBody? _defaultInstance;
/// The HTTP Content-Type header value specifying the content type of the body.
@$pb.TagNumber(1)
$core.String get contentType => $_getSZ(0);
@$pb.TagNumber(1)
set contentType($core.String value) => $_setString(0, value);
@$pb.TagNumber(1)
$core.bool hasContentType() => $_has(0);
@$pb.TagNumber(1)
void clearContentType() => $_clearField(1);
/// The HTTP request/response body as raw binary.
@$pb.TagNumber(2)
$core.List<$core.int> get data => $_getN(1);
@$pb.TagNumber(2)
set data($core.List<$core.int> value) => $_setBytes(1, value);
@$pb.TagNumber(2)
$core.bool hasData() => $_has(1);
@$pb.TagNumber(2)
void clearData() => $_clearField(2);
/// Application specific response metadata. Must be set in the first response
/// for streaming APIs.
@$pb.TagNumber(3)
$pb.PbList<$0.Any> get extensions => $_getList(2);
}
const $core.bool _omitFieldNames = $core.bool.fromEnvironment('protobuf.omit_field_names');
const $core.bool _omitMessageNames = $core.bool.fromEnvironment('protobuf.omit_message_names');