Package com.google.logging.v2

Interface UpdateSinkRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UpdateSinkRequest, UpdateSinkRequest.Builder
public interface UpdateSinkRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    LogSink
    getSink()
    Required.
    String
    getSinkName()
    Required.
    com.google.protobuf.ByteString
    getSinkNameBytes()
    Required.
    LogSinkOrBuilder
    getSinkOrBuilder()
    Required.
    boolean
    getUniqueWriterIdentity()
    Optional.
    com.google.protobuf.FieldMask
    getUpdateMask()
    Optional.
    com.google.protobuf.FieldMaskOrBuilder
    getUpdateMaskOrBuilder()
    Optional.
    boolean
    hasSink()
    Required.
    boolean
    hasUpdateMask()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSinkName

      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:
      The sinkName.

    • getSinkNameBytes

      com.google.protobuf.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:
      The bytes for sinkName.

    • hasSink

      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:
      Whether the sink field is set.

    • getSink

      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:
      The sink.

    • getSinkOrBuilder

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

    • getUniqueWriterIdentity

      boolean getUniqueWriterIdentity()
       Optional. See [sinks.create][google.logging.v2.ConfigServiceV2.CreateSink]
 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:
      The uniqueWriterIdentity.

    • hasUpdateMask

      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:
      Whether the updateMask field is set.

    • getUpdateMask

      com.google.protobuf.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:
      The updateMask.

    • getUpdateMaskOrBuilder

      com.google.protobuf.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];