Class UpdateSinkRequest (3.20.0)

public final class UpdateSinkRequest extends GeneratedMessageV3 implements UpdateSinkRequestOrBuilder

The parameters to UpdateSink.

Protobuf type google.logging.v2.UpdateSinkRequest

Static Fields

SINK_FIELD_NUMBER

public static final int SINK_FIELD_NUMBER
Field Value
Type Description
int

SINK_NAME_FIELD_NUMBER

public static final int SINK_NAME_FIELD_NUMBER
Field Value
Type Description
int

UNIQUE_WRITER_IDENTITY_FIELD_NUMBER

public static final int UNIQUE_WRITER_IDENTITY_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 UpdateSinkRequest getDefaultInstance()
Returns
Type Description
UpdateSinkRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateSinkRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public UpdateSinkRequest getDefaultInstanceForType()
Returns
Type Description
UpdateSinkRequest

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSink()

public LogSink getSink()

Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

.google.logging.v2.LogSink sink = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LogSink

The sink.

getSinkName()

public String getSinkName()

Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

 "projects/[PROJECT_ID]/sinks/[SINK_ID]"
 "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
 "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
 "folders/[FOLDER_ID]/sinks/[SINK_ID]"

For example:

"projects/my-project/sinks/my-sink"

string sink_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The sinkName.

getSinkNameBytes()

public ByteString getSinkNameBytes()

Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

 "projects/[PROJECT_ID]/sinks/[SINK_ID]"
 "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
 "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
 "folders/[FOLDER_ID]/sinks/[SINK_ID]"

For example:

"projects/my-project/sinks/my-sink"

string sink_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for sinkName.

getSinkOrBuilder()

public LogSinkOrBuilder getSinkOrBuilder()

Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

.google.logging.v2.LogSink sink = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LogSinkOrBuilder

getUniqueWriterIdentity()

public boolean getUniqueWriterIdentity()

Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:

  • If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.
  • If the old value is false and the new value is true, then writer_identity is changed to a unique service account.
  • It is an error if the old value is true and the new value is set to false or defaulted to false.

bool unique_writer_identity = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The uniqueWriterIdentity.

getUpdateMask()

public FieldMask getUpdateMask()

Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.

An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:

destination,filter,includeChildren

At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.

For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask

For example: updateMask=filter

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

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.

An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:

destination,filter,includeChildren

At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.

For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask

For example: updateMask=filter

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

Returns
Type Description
FieldMaskOrBuilder

hasSink()

public boolean hasSink()

Required. The updated sink, whose name is the same identifier that appears as part of sink_name.

.google.logging.v2.LogSink sink = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the sink field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.

An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:

destination,filter,includeChildren

At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.

For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask

For example: updateMask=filter

.google.protobuf.FieldMask update_mask = 4 [(.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 UpdateSinkRequest.Builder newBuilderForType()
Returns
Type Description
UpdateSinkRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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