target.apidocs.com.google.api.services.logging.v2.Logging.Projects.Sinks.html Maven / Gradle / Ivy
Logging.Projects.Sinks (Cloud Logging API v2-rev20240908-2.0.0)
com.google.api.services.logging.v2
Class Logging.Projects.Sinks
- java.lang.Object
-
- com.google.api.services.logging.v2.Logging.Projects.Sinks
-
- Enclosing class:
- Logging.Projects
public class Logging.Projects.Sinks
extends Object
The "sinks" collection of methods.
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
class
Logging.Projects.Sinks.Create
class
Logging.Projects.Sinks.Delete
class
Logging.Projects.Sinks.Get
class
Logging.Projects.Sinks.List
class
Logging.Projects.Sinks.Patch
class
Logging.Projects.Sinks.Update
-
Constructor Summary
Constructors
Constructor and Description
Sinks()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Logging.Projects.Sinks.Create
create(String parent,
LogSink content)
Creates a sink that exports specified log entries to a destination.
Logging.Projects.Sinks.Delete
delete(String sinkName)
Deletes a sink.
Logging.Projects.Sinks.Get
get(String sinkName)
Gets a sink.
Logging.Projects.Sinks.List
list(String parent)
Lists sinks.
Logging.Projects.Sinks.Patch
patch(String sinkName,
LogSink content)
Updates a sink.
Logging.Projects.Sinks.Update
update(String sinkName,
LogSink content)
Updates a sink.
-
-
Method Detail
-
create
public Logging.Projects.Sinks.Create create(String parent,
LogSink content)
throws IOException
Creates a sink that exports specified log entries to a destination. The export begins upon
ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink
can export log entries only from the resource owning the sink.
Create a request for the method "sinks.create".
This request holds the parameters needed by the logging server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
parent
- 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"
content
- the LogSink
- Returns:
- the request
- Throws:
IOException
-
delete
public Logging.Projects.Sinks.Delete delete(String sinkName)
throws IOException
Deletes a sink. If the sink has a unique writer_identity, then that service account is also
deleted.
Create a request for the method "sinks.delete".
This request holds the parameters needed by the logging server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
sinkName
- Required. The full resource name of the sink to delete, 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"
- Returns:
- the request
- Throws:
IOException
-
get
public Logging.Projects.Sinks.Get get(String sinkName)
throws IOException
Gets a sink.
Create a request for the method "sinks.get".
This request holds the parameters needed by the logging server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
sinkName
- Required. The resource name of the sink: "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"
- Returns:
- the request
- Throws:
IOException
-
list
public Logging.Projects.Sinks.List list(String parent)
throws IOException
Lists sinks.
Create a request for the method "sinks.list".
This request holds the parameters needed by the logging server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
parent
- Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
- Returns:
- the request
- Throws:
IOException
-
patch
public Logging.Projects.Sinks.Patch patch(String sinkName,
LogSink content)
throws IOException
Updates a sink. This method replaces the values of the destination and filter fields of the
existing sink with the corresponding values from the new sink.The updated sink might also have a
new writer_identity; see the unique_writer_identity field.
Create a request for the method "sinks.patch".
This request holds the parameters needed by the logging server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
sinkName
- 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"
content
- the LogSink
- Returns:
- the request
- Throws:
IOException
-
update
public Logging.Projects.Sinks.Update update(String sinkName,
LogSink content)
throws IOException
Updates a sink. This method replaces the values of the destination and filter fields of the
existing sink with the corresponding values from the new sink.The updated sink might also have a
new writer_identity; see the unique_writer_identity field.
Create a request for the method "sinks.update".
This request holds the parameters needed by the logging server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
sinkName
- 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"
content
- the LogSink
- Returns:
- the request
- Throws:
IOException
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy