Class Settings (0.31.0)

public final class Settings extends GeneratedMessageV3 implements SettingsOrBuilder

Settings for Advisory Notifications.

Protobuf type google.cloud.advisorynotifications.v1.Settings

Implements

SettingsOrBuilder

Static Fields

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_SETTINGS_FIELD_NUMBER

public static final int NOTIFICATION_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Settings getDefaultInstance()
Returns
Type Description
Settings

getDescriptor()

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

newBuilder()

public static Settings.Builder newBuilder()
Returns
Type Description
Settings.Builder

newBuilder(Settings prototype)

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

parseDelimitedFrom(InputStream input)

public static Settings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Settings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Settings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Settings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Settings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Settings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Settings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Settings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Settings> parser()
Returns
Type Description
Parser<Settings>

Methods

containsNotificationSettings(String key)

public boolean containsNotificationSettings(String key)

Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

map<string, .google.cloud.advisorynotifications.v1.NotificationSettings> notification_settings = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public Settings getDefaultInstanceForType()
Returns
Type Description
Settings

getEtag()

public String getEtag()

Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.

string etag = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.

string etag = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNotificationSettings() (deprecated)

public Map<String,NotificationSettings> getNotificationSettings()
Returns
Type Description
Map<String,NotificationSettings>

getNotificationSettingsCount()

public int getNotificationSettingsCount()

Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

map<string, .google.cloud.advisorynotifications.v1.NotificationSettings> notification_settings = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getNotificationSettingsMap()

public Map<String,NotificationSettings> getNotificationSettingsMap()

Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

map<string, .google.cloud.advisorynotifications.v1.NotificationSettings> notification_settings = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Map<String,NotificationSettings>

getNotificationSettingsOrDefault(String key, NotificationSettings defaultValue)

public NotificationSettings getNotificationSettingsOrDefault(String key, NotificationSettings defaultValue)

Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

map<string, .google.cloud.advisorynotifications.v1.NotificationSettings> notification_settings = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
key String
defaultValue NotificationSettings
Returns
Type Description
NotificationSettings

getNotificationSettingsOrThrow(String key)

public NotificationSettings getNotificationSettingsOrThrow(String key)

Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

map<string, .google.cloud.advisorynotifications.v1.NotificationSettings> notification_settings = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
NotificationSettings

getParserForType()

public Parser<Settings> getParserForType()
Returns
Type Description
Parser<Settings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Settings.Builder newBuilderForType()
Returns
Type Description
Settings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Settings.Builder toBuilder()
Returns
Type Description
Settings.Builder

writeTo(CodedOutputStream output)

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