Network Security API . organizations . locations . securityProfiles

close()

Close httplib2 connections.

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

Creates a new SecurityProfile in a given organization and location.

Args:
  parent: string, Required. The parent resource of the SecurityProfile. Must be in the format `projects|organizations/*/locations/{location}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 12
  "createTime": "A String", # Output only. Resource creation timestamp.
  "customMirroringProfile": { # CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup # The custom Packet Mirroring v2 configuration for the SecurityProfile.
    "mirroringEndpointGroup": "A String", # Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.
  },
  "description": "A String", # Optional. An optional description of the profile. Max length 512 characters.
  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "labels": { # Optional. Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.
  "threatPreventionProfile": { # ThreatPreventionProfile defines an action for specific threat signatures or severity levels. # The threat prevention configuration for the SecurityProfile.
    "severityOverrides": [ # Optional. Configuration for overriding threats actions by severity match.
      { # Defines what action to take for a specific severity match.
        "action": "A String", # Required. Threat action override.
        "severity": "A String", # Required. Severity level to match.
      },
    ],
    "threatOverrides": [ # Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.
      { # Defines what action to take for a specific threat_id match.
        "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
        "threatId": "A String", # Required. Vendor-specific ID of a threat to override.
        "type": "A String", # Output only. Type of the threat (read only).
      },
    ],
  },
  "type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures.
  "updateTime": "A String", # Output only. Last resource update timestamp.
}

  securityProfileId: string, Required. Short name of the SecurityProfile resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "security_profile1".
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

delete(name, etag=None, x__xgafv=None)

Deletes a single SecurityProfile.

Args:
  name: string, Required. A name of the SecurityProfile to delete. Must be in the format `projects|organizations/*/locations/{location}/securityProfiles/{security_profile_id}`. (required)
  etag: string, Optional. If client provided etag is out of date, delete will return FAILED_PRECONDITION error.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

get(name, x__xgafv=None)

Gets details of a single SecurityProfile.

Args:
  name: string, Required. A name of the SecurityProfile to get. Must be in the format `projects|organizations/*/locations/{location}/securityProfiles/{security_profile_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 12
  "createTime": "A String", # Output only. Resource creation timestamp.
  "customMirroringProfile": { # CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup # The custom Packet Mirroring v2 configuration for the SecurityProfile.
    "mirroringEndpointGroup": "A String", # Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.
  },
  "description": "A String", # Optional. An optional description of the profile. Max length 512 characters.
  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "labels": { # Optional. Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.
  "threatPreventionProfile": { # ThreatPreventionProfile defines an action for specific threat signatures or severity levels. # The threat prevention configuration for the SecurityProfile.
    "severityOverrides": [ # Optional. Configuration for overriding threats actions by severity match.
      { # Defines what action to take for a specific severity match.
        "action": "A String", # Required. Threat action override.
        "severity": "A String", # Required. Severity level to match.
      },
    ],
    "threatOverrides": [ # Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.
      { # Defines what action to take for a specific threat_id match.
        "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
        "threatId": "A String", # Required. Vendor-specific ID of a threat to override.
        "type": "A String", # Output only. Type of the threat (read only).
      },
    ],
  },
  "type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures.
  "updateTime": "A String", # Output only. Last resource update timestamp.
}

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

Lists SecurityProfiles in a given organization and location.

Args:
  parent: string, Required. The project or organization and location from which the SecurityProfiles should be listed, specified in the format `projects|organizations/*/locations/{location}`. (required)
  pageSize: integer, Maximum number of SecurityProfiles to return per call.
  pageToken: string, The value returned by the last `ListSecurityProfilesResponse` Indicates that this is a continuation of a prior `ListSecurityProfiles` call, and that the system should return the next page of data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response returned by the ListSecurityProfiles method.
  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
  "securityProfiles": [ # List of SecurityProfile resources.
    { # SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 12
      "createTime": "A String", # Output only. Resource creation timestamp.
      "customMirroringProfile": { # CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup # The custom Packet Mirroring v2 configuration for the SecurityProfile.
        "mirroringEndpointGroup": "A String", # Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.
      },
      "description": "A String", # Optional. An optional description of the profile. Max length 512 characters.
      "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
      "labels": { # Optional. Labels as key value pairs.
        "a_key": "A String",
      },
      "name": "A String", # Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.
      "threatPreventionProfile": { # ThreatPreventionProfile defines an action for specific threat signatures or severity levels. # The threat prevention configuration for the SecurityProfile.
        "severityOverrides": [ # Optional. Configuration for overriding threats actions by severity match.
          { # Defines what action to take for a specific severity match.
            "action": "A String", # Required. Threat action override.
            "severity": "A String", # Required. Severity level to match.
          },
        ],
        "threatOverrides": [ # Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.
          { # Defines what action to take for a specific threat_id match.
            "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
            "threatId": "A String", # Required. Vendor-specific ID of a threat to override.
            "type": "A String", # Output only. Type of the threat (read only).
          },
        ],
      },
      "type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures.
      "updateTime": "A String", # Output only. Last resource update timestamp.
    },
  ],
}

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 the parameters of a single SecurityProfile.

Args:
  name: string, Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 12
  "createTime": "A String", # Output only. Resource creation timestamp.
  "customMirroringProfile": { # CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup # The custom Packet Mirroring v2 configuration for the SecurityProfile.
    "mirroringEndpointGroup": "A String", # Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.
  },
  "description": "A String", # Optional. An optional description of the profile. Max length 512 characters.
  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "labels": { # Optional. Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.
  "threatPreventionProfile": { # ThreatPreventionProfile defines an action for specific threat signatures or severity levels. # The threat prevention configuration for the SecurityProfile.
    "severityOverrides": [ # Optional. Configuration for overriding threats actions by severity match.
      { # Defines what action to take for a specific severity match.
        "action": "A String", # Required. Threat action override.
        "severity": "A String", # Required. Severity level to match.
      },
    ],
    "threatOverrides": [ # Optional. Configuration for overriding threats actions by threat_id match. If a threat is matched both by configuration provided in severity_overrides and threat_overrides, the threat_overrides action is applied.
      { # Defines what action to take for a specific threat_id match.
        "action": "A String", # Required. Threat action override. For some threat types, only a subset of actions applies.
        "threatId": "A String", # Required. Vendor-specific ID of a threat to override.
        "type": "A String", # Output only. Type of the threat (read only).
      },
    ],
  },
  "type": "A String", # Immutable. The single ProfileType that the SecurityProfile resource configures.
  "updateTime": "A String", # Output only. Last resource update timestamp.
}

  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the SecurityProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}