Console
    Contact Us Start free

    Google Cloud Security Command Center V1 Client - Class MuteConfig (1.13.1)

    Reference documentation and code samples for the Google Cloud Security Command Center V1 Client class MuteConfig.

    A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.

    Generated from protobuf message google.cloud.securitycenter.v1.MuteConfig

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}"

    ↳ display_name
    string

    The human readable name to be displayed for the mute config.

    ↳ description
    string

    A description of the mute config.

    ↳ filter
    string

    Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: = , : * category: = , : * resource.name: = , : * resource.project_name: = , : * resource.project_display_name: = , : * resource.folders.resource_folder: = , : * resource.parent_name: = , : * resource.parent_display_name: = , : * resource.type: = , : * finding_class: = , : * indicator.ip_addresses: = , : * indicator.domains: = , :

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.

    ↳ most_recent_editor
    string

    Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.

    getName

    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}"

    Generated from protobuf field string name = 1;

    Returns
    Type
    Description
    string

    setName

    This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}"

    Generated from protobuf field string name = 1;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    The human readable name to be displayed for the mute config.

    Generated from protobuf field string display_name = 2 [deprecated = true];

    Returns
    Type
    Description
    string

    setDisplayName

    The human readable name to be displayed for the mute config.

    Generated from protobuf field string display_name = 2 [deprecated = true];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    A description of the mute config.

    Generated from protobuf field string description = 3;

    Returns
    Type
    Description
    string

    setDescription

    A description of the mute config.

    Generated from protobuf field string description = 3;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilter

    Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings.

    The following field and operator combinations are supported:

    • severity: = , :
    • category: = , :
    • resource.name: = , :
    • resource.project_name: = , :
    • resource.project_display_name: = , :
    • resource.folders.resource_folder: = , :
    • resource.parent_name: = , :
    • resource.parent_display_name: = , :
    • resource.type: = , :
    • finding_class: = , :
    • indicator.ip_addresses: = , :
    • indicator.domains: = , :

    Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = REQUIRED];

    Returns
    Type
    Description
    string

    setFilter

    Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings.

    The following field and operator combinations are supported:

    • severity: = , :
    • category: = , :
    • resource.name: = , :
    • resource.project_name: = , :
    • resource.project_display_name: = , :
    • resource.folders.resource_folder: = , :
    • resource.parent_name: = , :
    • resource.parent_display_name: = , :
    • resource.type: = , :
    • finding_class: = , :
    • indicator.ip_addresses: = , :
    • indicator.domains: = , :

    Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = REQUIRED];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. The time at which the mute config was created.

    This field is set by the server and will be ignored if provided on config creation.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The time at which the mute config was created.

    This field is set by the server and will be ignored if provided on config creation.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. The most recent time at which the mute config was updated.

    This field is set by the server and will be ignored if provided on config creation or update.

    Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. The most recent time at which the mute config was updated.

    This field is set by the server and will be ignored if provided on config creation or update.

    Generated from protobuf field .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getMostRecentEditor

    Output only. Email address of the user who last edited the mute config.

    This field is set by the server and will be ignored if provided on config creation or update.

    Generated from protobuf field string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    string

    setMostRecentEditor

    Output only. Email address of the user who last edited the mute config.

    This field is set by the server and will be ignored if provided on config creation or update.

    Generated from protobuf field string most_recent_editor = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: