1. class
  2. Google
  3. \
  4. Logging
  5. \
  6. V2
  7. \
  8. UpdateSinkRequest

UpdateSinkRequest

class UpdateSinkRequest extends Message

The parameters to UpdateSink.

Protobuf type Google\Logging\V2\UpdateSinkRequest

Methods

__construct()

No description

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]" Example: "projects/my-project-id/sinks/my-sink-id".

setSinkName(string $var)

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]" Example: "projects/my-project-id/sinks/my-sink-id".

LogSink
getSink()

Required. The updated sink, whose name is the same identifier that appears as part of sink_name. If sink_name does not exist, then this method creates a new sink.

setSink(LogSink $var)

Required. The updated sink, whose name is the same identifier that appears as part of sink_name. If sink_name does not exist, then this method creates a new sink.

bool
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.

setUniqueWriterIdentity(bool $var)

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.

Details

at line 54
__construct()

at line 71
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]" Example: "projects/my-project-id/sinks/my-sink-id".

Generated from protobuf field string sink_name = 1;

Return Value

string

at line 88
setSinkName(string $var)

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]" Example: "projects/my-project-id/sinks/my-sink-id".

Generated from protobuf field string sink_name = 1;

Parameters

string $var

at line 102
LogSink getSink()

Required. The updated sink, whose name is the same identifier that appears as part of sink_name. If sink_name does not exist, then this method creates a new sink.

Generated from protobuf field .google.logging.v2.LogSink sink = 2;

Return Value

LogSink

at line 115
setSink(LogSink $var)

Required. The updated sink, whose name is the same identifier that appears as part of sink_name. If sink_name does not exist, then this method creates a new sink.

Generated from protobuf field .google.logging.v2.LogSink sink = 2;

Parameters

LogSink $var

at line 136
bool 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 false.

Generated from protobuf field bool unique_writer_identity = 3;

Return Value

bool

at line 156
setUniqueWriterIdentity(bool $var)

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 false.

Generated from protobuf field bool unique_writer_identity = 3;

Parameters

bool $var