target.apidocs.com.google.api.services.securitycenter.v1.SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.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-securitycenter Show documentation

There is a newer version: v1-rev20241111-2.0.0

Show newest version







SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules (Security Command Center API v1-rev20240926-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.securitycenter.v1
Class SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules



java.lang.Object


com.google.api.services.securitycenter.v1.SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules







Enclosing class:
SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings




public class SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules
extends Object
The "customModules" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Create 


class 
SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Delete 


class 
SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Get 


class 
SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.List 


class 
SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.ListDescendant 


class 
SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Patch 


class 
SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Simulate 









Constructor Summary

Constructors 

Constructor and Description


CustomModules() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Create
create(String parent,
      GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule content)
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and
 also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given
 parent.



SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Delete
delete(String name)
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM
 hierarchy.



SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Get
get(String name)
Retrieves a SecurityHealthAnalyticsCustomModule.



SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.List
list(String parent)
Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent.



SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.ListDescendant
listDescendant(String parent)
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
 and all of the parent’s CRM descendants.



SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Patch
patch(String name,
     GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule content)
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update
 mask.



SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Simulate
simulate(String parent,
        SimulateSecurityHealthAnalyticsCustomModuleRequest content)
Simulates a given SecurityHealthAnalyticsCustomModule and Resource.







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














Constructor Detail





CustomModules
public CustomModules()









Method Detail





create
public SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Create create(String parent,
                                                                                                  GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule content)
                                                                                           throws IOException
Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and
 also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given
 parent. These modules are enabled by default.

 Create a request for the method "customModules.create".

 This request holds the parameters needed by the securitycenter server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. Resource name of the new custom module's parent. Its format is
        `organizations/{organization}/securityHealthAnalyticsSettings`,
        `folders/{folder}/securityHealthAnalyticsSettings`, or
        `projects/{project}/securityHealthAnalyticsSettings`
content - the GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule
Returns:
the request
Throws:
IOException








delete
public SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Delete delete(String name)
                                                                                           throws IOException
Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM
 hierarchy. This method is only supported for resident custom modules.

 Create a request for the method "customModules.delete".

 This request holds the parameters needed by the securitycenter server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the custom module to delete. Its format is
        `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}
        `, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or
        `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`
Returns:
the request
Throws:
IOException








get
public SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Get get(String name)
                                                                                     throws IOException
Retrieves a SecurityHealthAnalyticsCustomModule.

 Create a request for the method "customModules.get".

 This request holds the parameters needed by the securitycenter server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the custom module to get. Its format is
        `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}
        `, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or
        `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`
Returns:
the request
Throws:
IOException








list
public SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.List list(String parent)
                                                                                       throws IOException
Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent. This includes
 resident modules defined at the scope of the parent, and inherited modules, inherited from CRM
 ancestors.

 Create a request for the method "customModules.list".

 This request holds the parameters needed by the securitycenter server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. Name of parent to list custom modules. Its format is
        `organizations/{organization}/securityHealthAnalyticsSettings`,
        `folders/{folder}/securityHealthAnalyticsSettings`, or
        `projects/{project}/securityHealthAnalyticsSettings`
Returns:
the request
Throws:
IOException








listDescendant
public SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.ListDescendant listDescendant(String parent)
                                                                                                           throws IOException
Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent
 and all of the parent’s CRM descendants.

 Create a request for the method "customModules.listDescendant".

 This request holds the parameters needed by the securitycenter server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - Required. Name of parent to list descendant custom modules. Its format is
        `organizations/{organization}/securityHealthAnalyticsSettings`,
        `folders/{folder}/securityHealthAnalyticsSettings`, or
        `projects/{project}/securityHealthAnalyticsSettings`
Returns:
the request
Throws:
IOException








patch
public SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Patch patch(String name,
                                                                                                GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule content)
                                                                                         throws IOException
Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update
 mask. Updating the enablement state is supported on both resident and inherited modules (though
 resident modules cannot have an enablement state of "inherited"). Updating the display name and
 custom config of a module is supported on resident modules only.

 Create a request for the method "customModules.patch".

 This request holds the parameters needed by the securitycenter server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Immutable. The resource name of the custom module. Its format is
        "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}
        ", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or
        "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id
        {customModule} is server-generated and is not user settable. It will be a numeric id
        containing 1-20 digits.
content - the GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule
Returns:
the request
Throws:
IOException








simulate
public SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Simulate simulate(String parent,
                                                                                                      SimulateSecurityHealthAnalyticsCustomModuleRequest content)
                                                                                               throws IOException
Simulates a given SecurityHealthAnalyticsCustomModule and Resource.

 Create a request for the method "customModules.simulate".

 This request holds the parameters needed by the securitycenter server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The relative resource name of the organization, project, or folder. For more information
        about relative resource names, see [Relative Resource
        Name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) Example:
        `organizations/{organization_id}`
content - the SimulateSecurityHealthAnalyticsCustomModuleRequest
Returns:
the request
Throws:
IOException














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`	`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Create`
`class`	`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Delete`
`class`	`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Get`
`class`	`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.List`
`class`	`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.ListDescendant`
`class`	`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Patch`
`class`	`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Simulate`

Modifier and Type	Method and Description
`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Create`	`create(String parent, GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule content)` Creates a resident SecurityHealthAnalyticsCustomModule at the scope of the given CRM parent, and also creates inherited SecurityHealthAnalyticsCustomModules for all CRM descendants of the given parent.
`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Delete`	`delete(String name)` Deletes the specified SecurityHealthAnalyticsCustomModule and all of its descendants in the CRM hierarchy.
`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Get`	`get(String name)` Retrieves a SecurityHealthAnalyticsCustomModule.
`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.List`	`list(String parent)` Returns a list of all SecurityHealthAnalyticsCustomModules for the given parent.
`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.ListDescendant`	`listDescendant(String parent)` Returns a list of all resident SecurityHealthAnalyticsCustomModules under the given CRM parent and all of the parent’s CRM descendants.
`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Patch`	`patch(String name, GoogleCloudSecuritycenterV1SecurityHealthAnalyticsCustomModule content)` Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask.
`SecurityCommandCenter.Projects.SecurityHealthAnalyticsSettings.CustomModules.Simulate`	`simulate(String parent, SimulateSecurityHealthAnalyticsCustomModuleRequest content)` Simulates a given SecurityHealthAnalyticsCustomModule and Resource.