Class UpdateSettingsRequest (3.17.0)

public final class UpdateSettingsRequest extends GeneratedMessageV3 implements UpdateSettingsRequestOrBuilder

The parameters to UpdateSettings.

See Enabling CMEK for Log Router for more information.

Protobuf type google.logging.v2.UpdateSettingsRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SETTINGS_FIELD_NUMBER

public static final int SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateSettingsRequest getDefaultInstance()
Returns
Type Description
UpdateSettingsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateSettingsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public UpdateSettingsRequest getDefaultInstanceForType()
Returns
Type Description
UpdateSettingsRequest

getName()

public String getName()

Required. The resource name for the settings to update.

 "organizations/[ORGANIZATION_ID]/settings"

For example:

"organizations/12345/settings"

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name for the settings to update.

 "organizations/[ORGANIZATION_ID]/settings"

For example:

"organizations/12345/settings"

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSettings()

public Settings getSettings()

Required. The settings to update.

See Enabling CMEK for Log Router for more information.

.google.logging.v2.Settings settings = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Settings

The settings.

getSettingsOrBuilder()

public SettingsOrBuilder getSettingsOrBuilder()

Required. The settings to update.

See Enabling CMEK for Log Router for more information.

.google.logging.v2.Settings settings = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SettingsOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

See FieldMask for more information.

For example: "updateMask=kmsKeyName"

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

See FieldMask for more information.

For example: "updateMask=kmsKeyName"

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasSettings()

public boolean hasSettings()

Required. The settings to update.

See Enabling CMEK for Log Router for more information.

.google.logging.v2.Settings settings = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the settings field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

See FieldMask for more information.

For example: "updateMask=kmsKeyName"

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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