Package com.google.cloud.resourcesettings.v1

Class Setting

  • All Implemented Interfaces:
    SettingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Setting
extends com.google.protobuf.GeneratedMessageV3
implements SettingOrBuilder
     The schema for settings.
    Protobuf type google.cloud.resourcesettings.v1.Setting
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Setting.Builder
      The schema for settings.

      • 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

      • getName

        public String getName()
         The resource name of the setting. Must be in one of the following forms:

 * `projects/{project_number}/settings/{setting_name}`
 * `folders/{folder_id}/settings/{setting_name}`
 * `organizations/{organization_id}/settings/{setting_name}`

 For example, "/projects/123/settings/gcp-enableMyFeature"
        string name = 1;
        Specified by:
        getName in interface SettingOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the setting. Must be in one of the following forms:

 * `projects/{project_number}/settings/{setting_name}`
 * `folders/{folder_id}/settings/{setting_name}`
 * `organizations/{organization_id}/settings/{setting_name}`

 For example, "/projects/123/settings/gcp-enableMyFeature"
        string name = 1;
        Specified by:
        getNameBytes in interface SettingOrBuilder
        Returns:
        The bytes for name.

      • hasMetadata

        public boolean hasMetadata()
         Output only. Metadata about a setting which is not editable by the end user.
        .google.cloud.resourcesettings.v1.SettingMetadata metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasMetadata in interface SettingOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public SettingMetadata getMetadata()
         Output only. Metadata about a setting which is not editable by the end user.
        .google.cloud.resourcesettings.v1.SettingMetadata metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetadata in interface SettingOrBuilder
        Returns:
        The metadata.

      • getMetadataOrBuilder

        public SettingMetadataOrBuilder getMetadataOrBuilder()
         Output only. Metadata about a setting which is not editable by the end user.
        .google.cloud.resourcesettings.v1.SettingMetadata metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetadataOrBuilder in interface SettingOrBuilder

      • hasLocalValue

        public boolean hasLocalValue()
         The configured value of the setting at the given parent resource (ignoring
 the resource hierarchy). The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be
 consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].
        .google.cloud.resourcesettings.v1.Value local_value = 8;
        Specified by:
        hasLocalValue in interface SettingOrBuilder
        Returns:
        Whether the localValue field is set.

      • getLocalValue

        public Value getLocalValue()
         The configured value of the setting at the given parent resource (ignoring
 the resource hierarchy). The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be
 consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].
        .google.cloud.resourcesettings.v1.Value local_value = 8;
        Specified by:
        getLocalValue in interface SettingOrBuilder
        Returns:
        The localValue.

      • getLocalValueOrBuilder

        public ValueOrBuilder getLocalValueOrBuilder()
         The configured value of the setting at the given parent resource (ignoring
 the resource hierarchy). The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be
 consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].
        .google.cloud.resourcesettings.v1.Value local_value = 8;
        Specified by:
        getLocalValueOrBuilder in interface SettingOrBuilder

      • hasEffectiveValue

        public boolean hasEffectiveValue()
         Output only. The computed effective value of the setting at the given parent resource
 (based on the resource hierarchy).

 The effective value evaluates to one of the following options in the given
 order (the next option is used if the previous one does not exist):

 1. the local setting value on the given resource: [Setting.local_value][google.cloud.resourcesettings.v1.Setting.local_value]
 2. if one of the given resource's ancestors have a local setting value,
    the local value at the nearest such ancestor
 3. the setting's default value: [SettingMetadata.default_value][google.cloud.resourcesettings.v1.SettingMetadata.default_value]
 4. an empty value (defined as a `Value` with all fields unset)

 The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be
 consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].
        .google.cloud.resourcesettings.v1.Value effective_value = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasEffectiveValue in interface SettingOrBuilder
        Returns:
        Whether the effectiveValue field is set.

      • getEffectiveValue

        public Value getEffectiveValue()
         Output only. The computed effective value of the setting at the given parent resource
 (based on the resource hierarchy).

 The effective value evaluates to one of the following options in the given
 order (the next option is used if the previous one does not exist):

 1. the local setting value on the given resource: [Setting.local_value][google.cloud.resourcesettings.v1.Setting.local_value]
 2. if one of the given resource's ancestors have a local setting value,
    the local value at the nearest such ancestor
 3. the setting's default value: [SettingMetadata.default_value][google.cloud.resourcesettings.v1.SettingMetadata.default_value]
 4. an empty value (defined as a `Value` with all fields unset)

 The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be
 consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].
        .google.cloud.resourcesettings.v1.Value effective_value = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveValue in interface SettingOrBuilder
        Returns:
        The effectiveValue.

      • getEffectiveValueOrBuilder

        public ValueOrBuilder getEffectiveValueOrBuilder()
         Output only. The computed effective value of the setting at the given parent resource
 (based on the resource hierarchy).

 The effective value evaluates to one of the following options in the given
 order (the next option is used if the previous one does not exist):

 1. the local setting value on the given resource: [Setting.local_value][google.cloud.resourcesettings.v1.Setting.local_value]
 2. if one of the given resource's ancestors have a local setting value,
    the local value at the nearest such ancestor
 3. the setting's default value: [SettingMetadata.default_value][google.cloud.resourcesettings.v1.SettingMetadata.default_value]
 4. an empty value (defined as a `Value` with all fields unset)

 The data type of [Value][google.cloud.resourcesettings.v1.Value] must always be
 consistent with the data type defined in [Setting.metadata][google.cloud.resourcesettings.v1.Setting.metadata].
        .google.cloud.resourcesettings.v1.Value effective_value = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEffectiveValueOrBuilder in interface SettingOrBuilder

      • getEtag

        public String getEtag()
         A fingerprint used for optimistic concurrency. See
 [UpdateSetting][google.cloud.resourcesettings.v1.ResourceSettingsService.UpdateSetting] for more
 details.
        string etag = 10;
        Specified by:
        getEtag in interface SettingOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         A fingerprint used for optimistic concurrency. See
 [UpdateSetting][google.cloud.resourcesettings.v1.ResourceSettingsService.UpdateSetting] for more
 details.
        string etag = 10;
        Specified by:
        getEtagBytes in interface SettingOrBuilder
        Returns:
        The bytes for etag.

      • 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 Setting parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Setting parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Setting getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Setting> parser()

      • getParserForType

        public com.google.protobuf.Parser<Setting> 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 Setting getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder