target.apidocs.com.google.api.services.logging.v2.Logging.Folders.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-logging Show documentation

There is a newer version: v2-rev20241018-2.0.0

Show newest version







Logging.Folders (Cloud Logging API v2-rev20240419-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.logging.v2
Class Logging.Folders



java.lang.Object


com.google.api.services.logging.v2.Logging.Folders







Enclosing class:
Logging




public class Logging.Folders
extends Object
The "folders" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Logging.Folders.Exclusions
The "exclusions" collection of methods.



class 
Logging.Folders.GetCmekSettings 


class 
Logging.Folders.GetSettings 


class 
Logging.Folders.Locations
The "locations" collection of methods.



class 
Logging.Folders.Logs
The "logs" collection of methods.



class 
Logging.Folders.Sinks
The "sinks" collection of methods.



class 
Logging.Folders.UpdateSettings 









Constructor Summary

Constructors 

Constructor and Description


Folders() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Logging.Folders.Exclusions
exclusions()
An accessor for creating requests from the Exclusions collection.



Logging.Folders.GetCmekSettings
getCmekSettings(String name)
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be
 configured for Google Cloud projects, folders, organizations, and billing accounts.



Logging.Folders.GetSettings
getSettings(String name)
Gets the settings for the given resource.Note: Settings can be retrieved for Google Cloud
 projects, folders, organizations, and billing accounts.See View default resource settings for
 Logging (https://cloud.google.com/logging/docs/default-settings#view-org-settings) for more
 information.



Logging.Folders.Locations
locations()
An accessor for creating requests from the Locations collection.



Logging.Folders.Logs
logs()
An accessor for creating requests from the Logs collection.



Logging.Folders.Sinks
sinks()
An accessor for creating requests from the Sinks collection.



Logging.Folders.UpdateSettings
updateSettings(String name,
              Settings content)
Updates the settings for the given resource.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Folders
public Folders()









Method Detail





getCmekSettings
public Logging.Folders.GetCmekSettings getCmekSettings(String name)
                                                throws IOException
Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be
 configured for Google Cloud projects, folders, organizations, and billing accounts. Once
 configured for an organization, it applies to all projects and folders in the Google Cloud
 organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing
 /managed-encryption) for more information.

 Create a request for the method "folders.getCmekSettings".

 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:
name - Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings"
        "organizations/[ORGANIZATION_ID]/cmekSettings"
        "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For
        example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured
        for Google Cloud projects, folders, organizations, and billing accounts. Once configured
        for an organization, it applies to all projects and folders in the Google Cloud
        organization.
Returns:
the request
Throws:
IOException








getSettings
public Logging.Folders.GetSettings getSettings(String name)
                                        throws IOException
Gets the settings for the given resource.Note: Settings can be retrieved for Google Cloud
 projects, folders, organizations, and billing accounts.See View default resource settings for
 Logging (https://cloud.google.com/logging/docs/default-settings#view-org-settings) for more
 information.

 Create a request for the method "folders.getSettings".

 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:
name - Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings"
        "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings"
        "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings
        can be retrieved for Google Cloud projects, folders, organizations, and billing accounts.
Returns:
the request
Throws:
IOException








updateSettings
public Logging.Folders.UpdateSettings updateSettings(String name,
                                                     Settings content)
                                              throws IOException
Updates the settings for the given resource. This method applies to all feature configurations
 for organization and folders.UpdateSettings fails when any of the following are true: The value
 of storage_location either isn't supported by Logging or violates the location OrgPolicy. The
 default_sink_config field is set, but it has an unspecified filter write mode. The value of
 kms_key_name is invalid. The associated service account doesn't have the required
 roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is
 disabled.See Configure default settings for organizations and folders
 (https://cloud.google.com/logging/docs/default-settings) for more information.

 Create a request for the method "folders.updateSettings".

 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:
name - Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings"
        For example:"organizations/12345/settings"
content - the Settings
Returns:
the request
Throws:
IOException








exclusions
public Logging.Folders.Exclusions exclusions()
An accessor for creating requests from the Exclusions collection.

 The typical use is:
     Logging logging = new Logging(...);
    Logging.Exclusions.List request = logging.exclusions().list(parameters ...)
 

Returns:
the resource collection








locations
public Logging.Folders.Locations locations()
An accessor for creating requests from the Locations collection.

 The typical use is:
     Logging logging = new Logging(...);
    Logging.Locations.List request = logging.locations().list(parameters ...)
 

Returns:
the resource collection








logs
public Logging.Folders.Logs logs()
An accessor for creating requests from the Logs collection.

 The typical use is:
     Logging logging = new Logging(...);
    Logging.Logs.List request = logging.logs().list(parameters ...)
 

Returns:
the resource collection








sinks
public Logging.Folders.Sinks sinks()
An accessor for creating requests from the Sinks collection.

 The typical use is:
     Logging logging = new Logging(...);
    Logging.Sinks.List request = logging.sinks().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Logging.Folders.Exclusions` The "exclusions" collection of methods.
`class`	`Logging.Folders.GetCmekSettings`
`class`	`Logging.Folders.GetSettings`
`class`	`Logging.Folders.Locations` The "locations" collection of methods.
`class`	`Logging.Folders.Logs` The "logs" collection of methods.
`class`	`Logging.Folders.Sinks` The "sinks" collection of methods.
`class`	`Logging.Folders.UpdateSettings`

Modifier and Type	Method and Description
`Logging.Folders.Exclusions`	`exclusions()` An accessor for creating requests from the Exclusions collection.
`Logging.Folders.GetCmekSettings`	`getCmekSettings(String name)` Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts.
`Logging.Folders.GetSettings`	`getSettings(String name)` Gets the settings for the given resource.Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts.See View default resource settings for Logging (https://cloud.google.com/logging/docs/default-settings#view-org-settings) for more information.
`Logging.Folders.Locations`	`locations()` An accessor for creating requests from the Locations collection.
`Logging.Folders.Logs`	`logs()` An accessor for creating requests from the Logs collection.
`Logging.Folders.Sinks`	`sinks()` An accessor for creating requests from the Sinks collection.
`Logging.Folders.UpdateSettings`	`updateSettings(String name, Settings content)` Updates the settings for the given resource.