All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • target.apidocs.com.google.api.services.logging.v2.Logging.Projects.Sinks.Patch.html Maven / Gradle / Ivy

    There is a newer version: v2-rev20241018-2.0.0
    Show newest version
    





Logging.Projects.Sinks.Patch (Cloud Logging API v2-rev20240913-2.0.0)









    



    Skip navigation links
    





    

    




    


    

    



    



    



    

    com.google.api.services.logging.v2
    

    Class Logging.Projects.Sinks.Patch
    

    

    


    


    

    


    

    

      

    • 


        

      • 



        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
        
















































          

        • 

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

          • 

        





        • 

      

      • 

    

    

    



    



    Skip navigation links
    





    

    




    


    

    



    



    


    Copyright © 2011–2024 Google. All rights reserved.




    © 2015 - 2024 Weber Informatics LLC | Privacy Policy