target.apidocs.com.google.api.services.logging.v2.Logging.Sinks.Create.html Maven / Gradle / Ivy
Logging.Sinks.Create (Cloud Logging API v2-rev20240419-2.0.0)
com.google.api.services.logging.v2
Class Logging.Sinks.Create
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.logging.v2.LoggingRequest<LogSink>
-
- com.google.api.services.logging.v2.Logging.Sinks.Create
-
- Enclosing class:
- Logging.Sinks
public class Logging.Sinks.Create
extends LoggingRequest<LogSink>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Create(String parent,
LogSink content)
Creates a sink that exports specified log entries to a destination.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getCustomWriterIdentity()
Optional.
String
getParent()
Required.
Boolean
getUniqueWriterIdentity()
Optional.
Logging.Sinks.Create
set(String parameterName,
Object value)
Logging.Sinks.Create
set$Xgafv(String $Xgafv)
V1 error format.
Logging.Sinks.Create
setAccessToken(String accessToken)
OAuth access token.
Logging.Sinks.Create
setAlt(String alt)
Data format for response.
Logging.Sinks.Create
setCallback(String callback)
JSONP
Logging.Sinks.Create
setCustomWriterIdentity(String customWriterIdentity)
Optional.
Logging.Sinks.Create
setFields(String fields)
Selector specifying which fields to include in a partial response.
Logging.Sinks.Create
setKey(String key)
API key.
Logging.Sinks.Create
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Logging.Sinks.Create
setParent(String parent)
Required.
Logging.Sinks.Create
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Logging.Sinks.Create
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Logging.Sinks.Create
setUniqueWriterIdentity(Boolean uniqueWriterIdentity)
Optional.
Logging.Sinks.Create
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Logging.Sinks.Create
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.logging.v2.LoggingRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Constructor Detail
-
Create
protected Create(String parent,
LogSink content)
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 the logging server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation. Logging.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must
be called to initialize this instance immediately after invoking the constructor.
- 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
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Logging.Sinks.Create set$Xgafv(String $Xgafv)
Description copied from class: LoggingRequest
V1 error format.
- Overrides:
set$Xgafv
in class LoggingRequest<LogSink>
-
setAccessToken
public Logging.Sinks.Create setAccessToken(String accessToken)
Description copied from class: LoggingRequest
OAuth access token.
- Overrides:
setAccessToken
in class LoggingRequest<LogSink>
-
setAlt
public Logging.Sinks.Create setAlt(String alt)
Description copied from class: LoggingRequest
Data format for response.
- Overrides:
setAlt
in class LoggingRequest<LogSink>
-
setCallback
public Logging.Sinks.Create setCallback(String callback)
Description copied from class: LoggingRequest
JSONP
- Overrides:
setCallback
in class LoggingRequest<LogSink>
-
setFields
public Logging.Sinks.Create setFields(String fields)
Description copied from class: LoggingRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class LoggingRequest<LogSink>
-
setKey
public Logging.Sinks.Create setKey(String key)
Description copied from class: LoggingRequest
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
- Overrides:
setKey
in class LoggingRequest<LogSink>
-
setOauthToken
public Logging.Sinks.Create setOauthToken(String oauthToken)
Description copied from class: LoggingRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class LoggingRequest<LogSink>
-
setPrettyPrint
public Logging.Sinks.Create setPrettyPrint(Boolean prettyPrint)
Description copied from class: LoggingRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class LoggingRequest<LogSink>
-
setQuotaUser
public Logging.Sinks.Create setQuotaUser(String quotaUser)
Description copied from class: LoggingRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
assigned to a user, but should not exceed 40 characters.
- Overrides:
setQuotaUser
in class LoggingRequest<LogSink>
-
setUploadType
public Logging.Sinks.Create setUploadType(String uploadType)
Description copied from class: LoggingRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class LoggingRequest<LogSink>
-
setUploadProtocol
public Logging.Sinks.Create setUploadProtocol(String uploadProtocol)
Description copied from class: LoggingRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class LoggingRequest<LogSink>
-
getParent
public String 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"
-
setParent
public Logging.Sinks.Create setParent(String 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"
-
getCustomWriterIdentity
public String getCustomWriterIdentity()
Optional. A service account provided by the caller that will be used to write the log entries. The
format must be serviceAccount:some@email. This field can only be specified if you are routing logs
to a destination outside this sink's project. If not specified, a Logging service account will
automatically be generated.
-
setCustomWriterIdentity
public Logging.Sinks.Create setCustomWriterIdentity(String customWriterIdentity)
Optional. A service account provided by the caller that will be used to write the log
entries. The format must be serviceAccount:some@email. This field can only be specified if
you are routing logs to a destination outside this sink's project. If not specified, a
Logging service account will automatically be generated.
-
getUniqueWriterIdentity
public Boolean 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 service agent
(https://cloud.google.com/iam/docs/service-account-types#service-agents) used by the sinks with the
same parent. For more information, see writer_identity in LogSink.
-
setUniqueWriterIdentity
public Logging.Sinks.Create setUniqueWriterIdentity(Boolean uniqueWriterIdentity)
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 service agent (https://cloud.google.com/iam/docs/service-account-types#service-
agents) used by the sinks with the same parent. For more information, see writer_identity
in LogSink.
-
set
public Logging.Sinks.Create set(String parameterName,
Object value)
- Overrides:
set
in class LoggingRequest<LogSink>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy