Package com.google.cloud.resourcesettings.v1

Interface SettingOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Setting, Setting.Builder
    public interface SettingOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • hasMetadata

        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];
        Returns:
        Whether the metadata field is set.

      • getMetadata

        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];
        Returns:
        The metadata.

      • getMetadataOrBuilder

        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];

      • hasLocalValue

        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;
        Returns:
        Whether the localValue field is set.

      • getLocalValue

        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;
        Returns:
        The localValue.

      • getLocalValueOrBuilder

        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;

      • hasEffectiveValue

        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];
        Returns:
        Whether the effectiveValue field is set.

      • getEffectiveValue

        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];
        Returns:
        The effectiveValue.

      • getEffectiveValueOrBuilder

        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];

      • getEtag

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

      • getEtagBytes

        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;
        Returns:
        The bytes for etag.