Class Http (2.15.0)

public sealed class Http : IMessage<Http>, IEquatable<Http>, IDeepCloneable<Http>, IBufferMessage, IMessage

Defines the HTTP configuration for an API service. It contains a list of [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method to one or more HTTP REST API methods.

Inheritance

object > Http

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

Http()

public Http()

Http(Http)

public Http(Http other)
Parameter
Name Description
other Http

Fields

FullyDecodeReservedExpansionFieldNumber

public const int FullyDecodeReservedExpansionFieldNumber = 2

Field number for the "fully_decode_reserved_expansion" field.

Field Value
Type Description
int

RulesFieldNumber

public const int RulesFieldNumber = 1

Field number for the "rules" field.

Field Value
Type Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

FullyDecodeReservedExpansion

public bool FullyDecodeReservedExpansion { get; set; }

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.

The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

Property Value
Type Description
bool

Parser

public static MessageParser<Http> Parser { get; }
Property Value
Type Description
MessageParserHttp

Rules

public RepeatedField<HttpRule> Rules { get; }

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Property Value
Type Description
RepeatedFieldHttpRule

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type Description
int

The number of bytes required to write this message to a coded output stream.

Clone()

public Http Clone()

Creates a deep clone of this object.

Returns
Type Description
Http

A deep clone of this object.

Equals(Http)

public bool Equals(Http other)
Parameter
Name Description
other Http
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(Http)

public void MergeFrom(Http other)

Merges the given message into this one.

Parameter
Name Description
other Http
Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name Description
output CodedOutputStream

Coded output stream to write the data to. Must not be null.