target.apidocs.com.google.api.services.logging.v2.Logging.BillingAccounts.Sinks.Patch.html Maven / Gradle / Ivy
Logging.BillingAccounts.Sinks.Patch (Cloud Logging API v2-rev20240908-2.0.0)
com.google.api.services.logging.v2
Class Logging.BillingAccounts.Sinks.Patch
- 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.BillingAccounts.Sinks.Patch
-
- Enclosing class:
- Logging.BillingAccounts.Sinks
public class Logging.BillingAccounts.Sinks.Patch
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
Patch(String sinkName,
LogSink content)
Updates a sink.
-
Method Summary
-
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
-
Patch
protected Patch(String sinkName,
LogSink content)
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 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:
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
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Logging.BillingAccounts.Sinks.Patch set$Xgafv(String $Xgafv)
Description copied from class: LoggingRequest
V1 error format.
- Overrides:
set$Xgafv
in class LoggingRequest<LogSink>
-
setAccessToken
public Logging.BillingAccounts.Sinks.Patch setAccessToken(String accessToken)
Description copied from class: LoggingRequest
OAuth access token.
- Overrides:
setAccessToken
in class LoggingRequest<LogSink>
-
setAlt
public Logging.BillingAccounts.Sinks.Patch setAlt(String alt)
Description copied from class: LoggingRequest
Data format for response.
- Overrides:
setAlt
in class LoggingRequest<LogSink>
-
setCallback
public Logging.BillingAccounts.Sinks.Patch setCallback(String callback)
Description copied from class: LoggingRequest
JSONP
- Overrides:
setCallback
in class LoggingRequest<LogSink>
-
setFields
public Logging.BillingAccounts.Sinks.Patch 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.BillingAccounts.Sinks.Patch 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.BillingAccounts.Sinks.Patch 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.BillingAccounts.Sinks.Patch setPrettyPrint(Boolean prettyPrint)
Description copied from class: LoggingRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class LoggingRequest<LogSink>
-
setQuotaUser
public Logging.BillingAccounts.Sinks.Patch 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.BillingAccounts.Sinks.Patch 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.BillingAccounts.Sinks.Patch setUploadProtocol(String uploadProtocol)
Description copied from class: LoggingRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class LoggingRequest<LogSink>
-
getSinkName
public 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"
-
setSinkName
public Logging.BillingAccounts.Sinks.Patch setSinkName(String 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"
-
getCustomWriterIdentity
public String getCustomWriterIdentity()
Optional. The 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 when you are routing
logs to a log bucket that is in a different project than the sink. When not specified, a Logging
service account will automatically be generated.
-
setCustomWriterIdentity
public Logging.BillingAccounts.Sinks.Patch setCustomWriterIdentity(String customWriterIdentity)
Optional. The 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
when you are routing logs to a log bucket that is in a different project than the sink.
When not specified, a Logging service account will automatically be generated.
-
getUniqueWriterIdentity
public Boolean 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 service agent
(https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It
is an error if the old value is true and the new value is set to false or defaulted to false.
-
setUniqueWriterIdentity
public Logging.BillingAccounts.Sinks.Patch setUniqueWriterIdentity(Boolean uniqueWriterIdentity)
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 service
agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by
Cloud Logging. It is an error if the old value is true and the new value is set to false
or defaulted to false.
-
getUpdateMask
public String 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,includeChildrenAt 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.FieldMaskFor example: updateMask=filter
-
setUpdateMask
public Logging.BillingAccounts.Sinks.Patch setUpdateMask(String updateMask)
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,includeChildrenAt
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.FieldMaskFor example:
updateMask=filter
-
set
public Logging.BillingAccounts.Sinks.Patch 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