All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata Maven / Gradle / Ivy

The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: envoy/extensions/formatter/metadata/v3/metadata.proto

// Protobuf Java Version: 3.25.1
package io.envoyproxy.envoy.extensions.formatter.metadata.v3;

/**
 * 
 * %METADATA(TYPE:NAMESPACE:KEY):Z%
 *    :ref:`Metadata <envoy_v3_api_msg_config.core.v3.Metadata>` info,
 *    where TYPE is type of metadata (see above for supported types),
 *    NAMESPACE is the filter namespace used when setting the metadata, KEY is an optional
 *    lookup key in the namespace with the option of specifying nested keys separated by ':',
 *    and Z is an optional parameter denoting string truncation up to Z characters long.
 *    The data will be logged as a JSON string. For example, for the following ROUTE metadata:
 *
 *    ``com.test.my_filter: {"test_key": "foo", "test_object": {"inner_key": "bar"}}``
 *
 *    * %METADATA(ROUTE:com.test.my_filter)% will log: ``{"test_key": "foo", "test_object": {"inner_key": "bar"}}``
 *    * %METADATA(ROUTE:com.test.my_filter:test_key)% will log: ``foo``
 *    * %METADATA(ROUTE:com.test.my_filter:test_object)% will log: ``{"inner_key": "bar"}``
 *    * %METADATA(ROUTE:com.test.my_filter:test_object:inner_key)% will log: ``bar``
 *    * %METADATA(ROUTE:com.unknown_filter)% will log: ``-``
 *    * %METADATA(ROUTE:com.test.my_filter:unknown_key)% will log: ``-``
 *    * %METADATA(ROUTE:com.test.my_filter):25% will log (truncation at 25 characters): ``{"test_key": "foo", "test``
 *
 *  .. note::
 *
 *    For typed JSON logs, this operator renders a single value with string, numeric, or boolean type
 *    when the referenced key is a simple value. If the referenced key is a struct or list value, a
 *    JSON struct or list is rendered. Structs and lists may be nested. In any event, the maximum
 *    length is ignored.
 *
 *  .. note::
 *
 *    METADATA(DYNAMIC:NAMESPACE:KEY):Z is equivalent to :ref:`DYNAMIC_METADATA(NAMESPACE:KEY):Z<config_access_log_format_dynamic_metadata>`
 *    METADATA(CLUSTER:NAMESPACE:KEY):Z is equivalent to :ref:`CLUSTER_METADATA(NAMESPACE:KEY):Z<config_access_log_format_cluster_metadata>`
 *    METADATA(UPSTREAM_HOST:NAMESPACE:KEY):Z is equivalent to :ref:`UPSTREAM_METADATA(NAMESPACE:KEY):Z<config_access_log_format_upstream_host_metadata>`
 *
 * .. warning::
 *   This extension is treated as built-in extension and will be enabled by default now.
 *   It is unnecessary to configure this extension.
 * 
* * Protobuf type {@code envoy.extensions.formatter.metadata.v3.Metadata} */ public final class Metadata extends com.google.protobuf.GeneratedMessageV3 implements // @@protoc_insertion_point(message_implements:envoy.extensions.formatter.metadata.v3.Metadata) MetadataOrBuilder { private static final long serialVersionUID = 0L; // Use Metadata.newBuilder() to construct. private Metadata(com.google.protobuf.GeneratedMessageV3.Builder builder) { super(builder); } private Metadata() { } @java.lang.Override @SuppressWarnings({"unused"}) protected java.lang.Object newInstance( UnusedPrivateParameter unused) { return new Metadata(); } public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { return io.envoyproxy.envoy.extensions.formatter.metadata.v3.MetadataProto.internal_static_envoy_extensions_formatter_metadata_v3_Metadata_descriptor; } @java.lang.Override protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable() { return io.envoyproxy.envoy.extensions.formatter.metadata.v3.MetadataProto.internal_static_envoy_extensions_formatter_metadata_v3_Metadata_fieldAccessorTable .ensureFieldAccessorsInitialized( io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata.class, io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata.Builder.class); } private byte memoizedIsInitialized = -1; @java.lang.Override public final boolean isInitialized() { byte isInitialized = memoizedIsInitialized; if (isInitialized == 1) return true; if (isInitialized == 0) return false; memoizedIsInitialized = 1; return true; } @java.lang.Override public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException { getUnknownFields().writeTo(output); } @java.lang.Override public int getSerializedSize() { int size = memoizedSize; if (size != -1) return size; size = 0; size += getUnknownFields().getSerializedSize(); memoizedSize = size; return size; } @java.lang.Override public boolean equals(final java.lang.Object obj) { if (obj == this) { return true; } if (!(obj instanceof io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata)) { return super.equals(obj); } io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata other = (io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata) obj; if (!getUnknownFields().equals(other.getUnknownFields())) return false; return true; } @java.lang.Override public int hashCode() { if (memoizedHashCode != 0) { return memoizedHashCode; } int hash = 41; hash = (19 * hash) + getDescriptor().hashCode(); hash = (29 * hash) + getUnknownFields().hashCode(); memoizedHashCode = hash; return hash; } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom( java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom( java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data, extensionRegistry); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom( com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom( com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data, extensionRegistry); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom( byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException { return PARSER.parseFrom(data, extensionRegistry); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom(java.io.InputStream input) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3 .parseWithIOException(PARSER, input); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom( java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3 .parseWithIOException(PARSER, input, extensionRegistry); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3 .parseDelimitedWithIOException(PARSER, input); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseDelimitedFrom( java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3 .parseDelimitedWithIOException(PARSER, input, extensionRegistry); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom( com.google.protobuf.CodedInputStream input) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3 .parseWithIOException(PARSER, input); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata parseFrom( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException { return com.google.protobuf.GeneratedMessageV3 .parseWithIOException(PARSER, input, extensionRegistry); } @java.lang.Override public Builder newBuilderForType() { return newBuilder(); } public static Builder newBuilder() { return DEFAULT_INSTANCE.toBuilder(); } public static Builder newBuilder(io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata prototype) { return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype); } @java.lang.Override public Builder toBuilder() { return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this); } @java.lang.Override protected Builder newBuilderForType( com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { Builder builder = new Builder(parent); return builder; } /** *
   * %METADATA(TYPE:NAMESPACE:KEY):Z%
   *    :ref:`Metadata <envoy_v3_api_msg_config.core.v3.Metadata>` info,
   *    where TYPE is type of metadata (see above for supported types),
   *    NAMESPACE is the filter namespace used when setting the metadata, KEY is an optional
   *    lookup key in the namespace with the option of specifying nested keys separated by ':',
   *    and Z is an optional parameter denoting string truncation up to Z characters long.
   *    The data will be logged as a JSON string. For example, for the following ROUTE metadata:
   *
   *    ``com.test.my_filter: {"test_key": "foo", "test_object": {"inner_key": "bar"}}``
   *
   *    * %METADATA(ROUTE:com.test.my_filter)% will log: ``{"test_key": "foo", "test_object": {"inner_key": "bar"}}``
   *    * %METADATA(ROUTE:com.test.my_filter:test_key)% will log: ``foo``
   *    * %METADATA(ROUTE:com.test.my_filter:test_object)% will log: ``{"inner_key": "bar"}``
   *    * %METADATA(ROUTE:com.test.my_filter:test_object:inner_key)% will log: ``bar``
   *    * %METADATA(ROUTE:com.unknown_filter)% will log: ``-``
   *    * %METADATA(ROUTE:com.test.my_filter:unknown_key)% will log: ``-``
   *    * %METADATA(ROUTE:com.test.my_filter):25% will log (truncation at 25 characters): ``{"test_key": "foo", "test``
   *
   *  .. note::
   *
   *    For typed JSON logs, this operator renders a single value with string, numeric, or boolean type
   *    when the referenced key is a simple value. If the referenced key is a struct or list value, a
   *    JSON struct or list is rendered. Structs and lists may be nested. In any event, the maximum
   *    length is ignored.
   *
   *  .. note::
   *
   *    METADATA(DYNAMIC:NAMESPACE:KEY):Z is equivalent to :ref:`DYNAMIC_METADATA(NAMESPACE:KEY):Z<config_access_log_format_dynamic_metadata>`
   *    METADATA(CLUSTER:NAMESPACE:KEY):Z is equivalent to :ref:`CLUSTER_METADATA(NAMESPACE:KEY):Z<config_access_log_format_cluster_metadata>`
   *    METADATA(UPSTREAM_HOST:NAMESPACE:KEY):Z is equivalent to :ref:`UPSTREAM_METADATA(NAMESPACE:KEY):Z<config_access_log_format_upstream_host_metadata>`
   *
   * .. warning::
   *   This extension is treated as built-in extension and will be enabled by default now.
   *   It is unnecessary to configure this extension.
   * 
* * Protobuf type {@code envoy.extensions.formatter.metadata.v3.Metadata} */ public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder implements // @@protoc_insertion_point(builder_implements:envoy.extensions.formatter.metadata.v3.Metadata) io.envoyproxy.envoy.extensions.formatter.metadata.v3.MetadataOrBuilder { public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { return io.envoyproxy.envoy.extensions.formatter.metadata.v3.MetadataProto.internal_static_envoy_extensions_formatter_metadata_v3_Metadata_descriptor; } @java.lang.Override protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable() { return io.envoyproxy.envoy.extensions.formatter.metadata.v3.MetadataProto.internal_static_envoy_extensions_formatter_metadata_v3_Metadata_fieldAccessorTable .ensureFieldAccessorsInitialized( io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata.class, io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata.Builder.class); } // Construct using io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata.newBuilder() private Builder() { } private Builder( com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { super(parent); } @java.lang.Override public Builder clear() { super.clear(); return this; } @java.lang.Override public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() { return io.envoyproxy.envoy.extensions.formatter.metadata.v3.MetadataProto.internal_static_envoy_extensions_formatter_metadata_v3_Metadata_descriptor; } @java.lang.Override public io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata getDefaultInstanceForType() { return io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata.getDefaultInstance(); } @java.lang.Override public io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata build() { io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata result = buildPartial(); if (!result.isInitialized()) { throw newUninitializedMessageException(result); } return result; } @java.lang.Override public io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata buildPartial() { io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata result = new io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata(this); onBuilt(); return result; } @java.lang.Override public Builder clone() { return super.clone(); } @java.lang.Override public Builder setField( com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { return super.setField(field, value); } @java.lang.Override public Builder clearField( com.google.protobuf.Descriptors.FieldDescriptor field) { return super.clearField(field); } @java.lang.Override public Builder clearOneof( com.google.protobuf.Descriptors.OneofDescriptor oneof) { return super.clearOneof(oneof); } @java.lang.Override public Builder setRepeatedField( com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value) { return super.setRepeatedField(field, index, value); } @java.lang.Override public Builder addRepeatedField( com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { return super.addRepeatedField(field, value); } @java.lang.Override public Builder mergeFrom(com.google.protobuf.Message other) { if (other instanceof io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata) { return mergeFrom((io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata)other); } else { super.mergeFrom(other); return this; } } public Builder mergeFrom(io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata other) { if (other == io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata.getDefaultInstance()) return this; this.mergeUnknownFields(other.getUnknownFields()); onChanged(); return this; } @java.lang.Override public final boolean isInitialized() { return true; } @java.lang.Override public Builder mergeFrom( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException { if (extensionRegistry == null) { throw new java.lang.NullPointerException(); } try { boolean done = false; while (!done) { int tag = input.readTag(); switch (tag) { case 0: done = true; break; default: { if (!super.parseUnknownField(input, extensionRegistry, tag)) { done = true; // was an endgroup tag } break; } // default: } // switch (tag) } // while (!done) } catch (com.google.protobuf.InvalidProtocolBufferException e) { throw e.unwrapIOException(); } finally { onChanged(); } // finally return this; } @java.lang.Override public final Builder setUnknownFields( final com.google.protobuf.UnknownFieldSet unknownFields) { return super.setUnknownFields(unknownFields); } @java.lang.Override public final Builder mergeUnknownFields( final com.google.protobuf.UnknownFieldSet unknownFields) { return super.mergeUnknownFields(unknownFields); } // @@protoc_insertion_point(builder_scope:envoy.extensions.formatter.metadata.v3.Metadata) } // @@protoc_insertion_point(class_scope:envoy.extensions.formatter.metadata.v3.Metadata) private static final io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata DEFAULT_INSTANCE; static { DEFAULT_INSTANCE = new io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata(); } public static io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata getDefaultInstance() { return DEFAULT_INSTANCE; } private static final com.google.protobuf.Parser PARSER = new com.google.protobuf.AbstractParser() { @java.lang.Override public Metadata parsePartialFrom( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException { Builder builder = newBuilder(); try { builder.mergeFrom(input, extensionRegistry); } catch (com.google.protobuf.InvalidProtocolBufferException e) { throw e.setUnfinishedMessage(builder.buildPartial()); } catch (com.google.protobuf.UninitializedMessageException e) { throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial()); } catch (java.io.IOException e) { throw new com.google.protobuf.InvalidProtocolBufferException(e) .setUnfinishedMessage(builder.buildPartial()); } return builder.buildPartial(); } }; public static com.google.protobuf.Parser parser() { return PARSER; } @java.lang.Override public com.google.protobuf.Parser getParserForType() { return PARSER; } @java.lang.Override public io.envoyproxy.envoy.extensions.formatter.metadata.v3.Metadata getDefaultInstanceForType() { return DEFAULT_INSTANCE; } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy