Package com.google.cloud.compute.v1

Class BackendServiceLogConfig

  • All Implemented Interfaces:
    BackendServiceLogConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BackendServiceLogConfig
extends com.google.protobuf.GeneratedMessageV3
implements BackendServiceLogConfigOrBuilder
     The available logging options for the load balancer traffic served by this backend service.
    Protobuf type google.cloud.compute.v1.BackendServiceLogConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  BackendServiceLogConfig.Builder
      The available logging options for the load balancer traffic served by this backend service.
      static class  BackendServiceLogConfig.OptionalMode
      This field can only be specified if logging is enabled for this backend service.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasEnable

        public boolean hasEnable()
         Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
        optional bool enable = 311764355;
        Specified by:
        hasEnable in interface BackendServiceLogConfigOrBuilder
        Returns:
        Whether the enable field is set.

      • getEnable

        public boolean getEnable()
         Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.
        optional bool enable = 311764355;
        Specified by:
        getEnable in interface BackendServiceLogConfigOrBuilder
        Returns:
        The enable.

      • getOptionalFieldsList

        public com.google.protobuf.ProtocolStringList getOptionalFieldsList()
         This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
        repeated string optional_fields = 528589944;
        Specified by:
        getOptionalFieldsList in interface BackendServiceLogConfigOrBuilder
        Returns:
        A list containing the optionalFields.

      • getOptionalFieldsCount

        public int getOptionalFieldsCount()
         This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
        repeated string optional_fields = 528589944;
        Specified by:
        getOptionalFieldsCount in interface BackendServiceLogConfigOrBuilder
        Returns:
        The count of optionalFields.

      • getOptionalFields

        public String getOptionalFields​(int index)
         This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
        repeated string optional_fields = 528589944;
        Specified by:
        getOptionalFields in interface BackendServiceLogConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The optionalFields at the given index.

      • getOptionalFieldsBytes

        public com.google.protobuf.ByteString getOptionalFieldsBytes​(int index)
         This field can only be specified if logging is enabled for this backend service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace
        repeated string optional_fields = 528589944;
        Specified by:
        getOptionalFieldsBytes in interface BackendServiceLogConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the optionalFields at the given index.

      • hasOptionalMode

        public boolean hasOptionalMode()
         This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
 Check the OptionalMode enum for the list of possible values.
        optional string optional_mode = 128697122;
        Specified by:
        hasOptionalMode in interface BackendServiceLogConfigOrBuilder
        Returns:
        Whether the optionalMode field is set.

      • getOptionalMode

        public String getOptionalMode()
         This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
 Check the OptionalMode enum for the list of possible values.
        optional string optional_mode = 128697122;
        Specified by:
        getOptionalMode in interface BackendServiceLogConfigOrBuilder
        Returns:
        The optionalMode.

      • getOptionalModeBytes

        public com.google.protobuf.ByteString getOptionalModeBytes()
         This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.
 Check the OptionalMode enum for the list of possible values.
        optional string optional_mode = 128697122;
        Specified by:
        getOptionalModeBytes in interface BackendServiceLogConfigOrBuilder
        Returns:
        The bytes for optionalMode.

      • hasSampleRate

        public boolean hasSampleRate()
         This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
        optional float sample_rate = 153193045;
        Specified by:
        hasSampleRate in interface BackendServiceLogConfigOrBuilder
        Returns:
        Whether the sampleRate field is set.

      • getSampleRate

        public float getSampleRate()
         This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.
        optional float sample_rate = 153193045;
        Specified by:
        getSampleRate in interface BackendServiceLogConfigOrBuilder
        Returns:
        The sampleRate.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static BackendServiceLogConfig parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BackendServiceLogConfig parseFrom​(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BackendServiceLogConfig parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BackendServiceLogConfig parseFrom​(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BackendServiceLogConfig parseFrom​(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BackendServiceLogConfig parseFrom​(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public BackendServiceLogConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public BackendServiceLogConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected BackendServiceLogConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<BackendServiceLogConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public BackendServiceLogConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder