Class AttributeContext.Api (2.38.0)

public static final class AttributeContext.Api extends GeneratedMessageV3 implements AttributeContext.ApiOrBuilder

This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.

Protobuf type google.rpc.context.AttributeContext.Api

Static Fields

OPERATION_FIELD_NUMBER

public static final int OPERATION_FIELD_NUMBER
Field Value
Type Description
int

PROTOCOL_FIELD_NUMBER

public static final int PROTOCOL_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
Type Description
int

VERSION_FIELD_NUMBER

public static final int VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AttributeContext.Api getDefaultInstance()
Returns
Type Description
AttributeContext.Api

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AttributeContext.Api.Builder newBuilder()
Returns
Type Description
AttributeContext.Api.Builder

newBuilder(AttributeContext.Api prototype)

public static AttributeContext.Api.Builder newBuilder(AttributeContext.Api prototype)
Parameter
Name Description
prototype AttributeContext.Api
Returns
Type Description
AttributeContext.Api.Builder

parseDelimitedFrom(InputStream input)

public static AttributeContext.Api parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributeContext.Api parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AttributeContext.Api parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AttributeContext.Api parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AttributeContext.Api parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AttributeContext.Api parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AttributeContext.Api parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributeContext.Api parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AttributeContext.Api parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AttributeContext.Api parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AttributeContext.Api parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AttributeContext.Api parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AttributeContext.Api
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AttributeContext.Api> parser()
Returns
Type Description
Parser<Api>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AttributeContext.Api getDefaultInstanceForType()
Returns
Type Description
AttributeContext.Api

getOperation()

public String getOperation()

The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the operationId, such as "getPet".

string operation = 2;

Returns
Type Description
String

The operation.

getOperationBytes()

public ByteString getOperationBytes()

The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the operationId, such as "getPet".

string operation = 2;

Returns
Type Description
ByteString

The bytes for operation.

getParserForType()

public Parser<AttributeContext.Api> getParserForType()
Returns
Type Description
Parser<Api>
Overrides

getProtocol()

public String getProtocol()

The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

string protocol = 3;

Returns
Type Description
String

The protocol.

getProtocolBytes()

public ByteString getProtocolBytes()

The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

string protocol = 3;

Returns
Type Description
ByteString

The bytes for protocol.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getService()

public String getService()

The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

string service = 1;

Returns
Type Description
String

The service.

getServiceBytes()

public ByteString getServiceBytes()

The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

string service = 1;

Returns
Type Description
ByteString

The bytes for service.

getVersion()

public String getVersion()

The API version associated with the API operation above, such as "v1" or "v1alpha1".

string version = 4;

Returns
Type Description
String

The version.

getVersionBytes()

public ByteString getVersionBytes()

The API version associated with the API operation above, such as "v1" or "v1alpha1".

string version = 4;

Returns
Type Description
ByteString

The bytes for version.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AttributeContext.Api.Builder newBuilderForType()
Returns
Type Description
AttributeContext.Api.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AttributeContext.Api.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AttributeContext.Api.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AttributeContext.Api.Builder toBuilder()
Returns
Type Description
AttributeContext.Api.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException