Reference documentation and code samples for the Stackdriver Logging V2 Client class CreateSinkRequest.
The parameters to CreateSink.
Generated from protobuf message google.logging.v2.CreateSinkRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples: |
↳ sink |
Google\Cloud\Logging\V2\LogSink
Required. The new sink, whose |
↳ unique_writer_identity |
bool
Optional. Determines the kind of IAM identity returned as |
getParent
Required. The resource in which to create the sink:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
For examples:
"projects/my-project"
"organizations/123456789"
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource in which to create the sink:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
For examples:
"projects/my-project"
"organizations/123456789"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSink
Required. The new sink, whose name parameter is a sink identifier that
is not already in use.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Logging\V2\LogSink|null | |
hasSink
clearSink
setSink
Required. The new sink, whose name parameter is a sink identifier that
is not already in use.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Logging\V2\LogSink
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUniqueWriterIdentity
Optional. Determines the kind of IAM identity returned as writer_identity
in the new sink. If this value is omitted or set to false, and if the
sink's parent is a project, then the value returned as writer_identity is
the same group or service account used by Cloud Logging before the addition
of writer identities to this API. The sink's destination must be in the
same project as the sink itself.
If this field is set to true, or if the sink is owned by a non-project
resource such as an organization, then the value of writer_identity will
be a unique service account used only for exports from the new sink. For
more information, see writer_identity in LogSink.
| Returns | |
|---|---|
| Type | Description |
bool | |
setUniqueWriterIdentity
Optional. Determines the kind of IAM identity returned as writer_identity
in the new sink. If this value is omitted or set to false, and if the
sink's parent is a project, then the value returned as writer_identity is
the same group or service account used by Cloud Logging before the addition
of writer identities to this API. The sink's destination must be in the
same project as the sink itself.
If this field is set to true, or if the sink is owned by a non-project
resource such as an organization, then the value of writer_identity will
be a unique service account used only for exports from the new sink. For
more information, see writer_identity in LogSink.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |