Security Command Center API . organizations . eventThreatDetectionSettings . customModules

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates an Event Threat Detection custom module.

delete(name, x__xgafv=None)

Deletes an Event Threat Detection custom module.

get(name, x__xgafv=None)

Gets an Event Threat Detection custom module.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists Event Threat Detection custom modules.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates an Event Threat Detection custom module.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates an Event Threat Detection custom module.

Args:
  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
    "a_key": "", # Properties of the object.
  },
  "description": "A String", # The description for the module.
  "displayName": "A String", # The human readable name to be displayed for the module.
  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
  "lastEditor": "A String", # Output only. The editor the module was last updated by.
  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
  "updateTime": "A String", # Output only. The time the module was last updated.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
    "a_key": "", # Properties of the object.
  },
  "description": "A String", # The description for the module.
  "displayName": "A String", # The human readable name to be displayed for the module.
  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
  "lastEditor": "A String", # Output only. The editor the module was last updated by.
  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
  "updateTime": "A String", # Output only. The time the module was last updated.
}
delete(name, x__xgafv=None)
Deletes an Event Threat Detection custom module.

Args:
  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Gets an Event Threat Detection custom module.

Args:
  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
    "a_key": "", # Properties of the object.
  },
  "description": "A String", # The description for the module.
  "displayName": "A String", # The human readable name to be displayed for the module.
  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
  "lastEditor": "A String", # Output only. The editor the module was last updated by.
  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
  "updateTime": "A String", # Output only. The time the module was last updated.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Event Threat Detection custom modules.

Args:
  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". (required)
  pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for listing Event Threat Detection custom modules.
  "eventThreatDetectionCustomModules": [ # Custom modules belonging to the requested parent.
    { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
      "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
        "a_key": "", # Properties of the object.
      },
      "description": "A String", # The description for the module.
      "displayName": "A String", # The human readable name to be displayed for the module.
      "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
      "lastEditor": "A String", # Output only. The editor the module was last updated by.
      "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
      "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
      "updateTime": "A String", # Output only. The time the module was last updated.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an Event Threat Detection custom module.

Args:
  name: string, Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
    "a_key": "", # Properties of the object.
  },
  "description": "A String", # The description for the module.
  "displayName": "A String", # The human readable name to be displayed for the module.
  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
  "lastEditor": "A String", # Output only. The editor the module was last updated by.
  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
  "updateTime": "A String", # Output only. The time the module was last updated.
}

  updateMask: string, The list of fields to be updated. If empty all mutable fields will be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an instance of an Event Threat Detection custom module, including its full module name, display name, enablement state, and last updated time. You can create a custom module at the organization level only.
  "config": { # Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module.
    "a_key": "", # Properties of the object.
  },
  "description": "A String", # The description for the module.
  "displayName": "A String", # The human readable name to be displayed for the module.
  "enablementState": "A String", # The state of enablement for the module at the given level of the hierarchy.
  "lastEditor": "A String", # Output only. The editor the module was last updated by.
  "name": "A String", # Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}".
  "type": "A String", # Type for the module. e.g. CONFIGURABLE_BAD_IP.
  "updateTime": "A String", # Output only. The time the module was last updated.
}