As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Ids v1 API

class google.cloud.ids_v1.types.CreateEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

parent

Required. The endpoint’s parent.

Type

str

endpoint_id

Required. The endpoint identifier. This will be part of the endpoint’s resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

Type

str

endpoint

Required. The endpoint to create.

Type

google.cloud.ids_v1.types.Endpoint

request_id

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.ids_v1.types.DeleteEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

name

Required. The name of the endpoint to delete.

Type

str

request_id

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Type

str

class google.cloud.ids_v1.types.Endpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.

name

Output only. The name of the endpoint.

Type

str

create_time

Output only. The create time timestamp.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The update time timestamp.

Type

google.protobuf.timestamp_pb2.Timestamp

labels

The labels of the endpoint.

Type

MutableMapping[str, str]

network

Required. The fully qualified URL of the network to which the IDS Endpoint is attached.

Type

str

endpoint_forwarding_rule

Output only. The fully qualified URL of the endpoint’s ILB Forwarding Rule.

Type

str

endpoint_ip

Output only. The IP address of the IDS Endpoint’s ILB.

Type

str

description

User-provided description of the endpoint

Type

str

severity

Required. Lowest threat severity that this endpoint will alert on.

Type

google.cloud.ids_v1.types.Endpoint.Severity

state

Output only. Current state of the endpoint.

Type

google.cloud.ids_v1.types.Endpoint.State

traffic_logs

Whether the endpoint should report traffic logs in addition to threat logs.

Type

bool

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class Severity(value)

Bases: proto.enums.Enum

Threat severity levels.

Values:

SEVERITY_UNSPECIFIED (0):

Not set.

INFORMATIONAL (1):

Informational alerts.

LOW (2):

Low severity alerts.

MEDIUM (3):

Medium severity alerts.

HIGH (4):

High severity alerts.

CRITICAL (5):

Critical severity alerts.

class State(value)

Bases: proto.enums.Enum

Endpoint state

Values:

STATE_UNSPECIFIED (0):

Not set.

CREATING (1):

Being created.

READY (2):

Active and ready for traffic.

DELETING (3):

Being deleted.

class google.cloud.ids_v1.types.GetEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

name

Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

Type

str

class google.cloud.ids_v1.types.ListEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

parent

Required. The parent, which owns this collection of endpoints.

Type

str

page_size

Optional. The maximum number of endpoints to return. The service may return fewer than this value.

Type

int

page_token

Optional. A page token, received from a previous ListEndpoints call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListEndpoints must match the call that provided the page token.

Type

str

filter

Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.

Type

str

order_by

Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

Type

str

class google.cloud.ids_v1.types.ListEndpointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

endpoints

The list of endpoints response.

Type

MutableSequence[google.cloud.ids_v1.types.Endpoint]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

unreachable

Locations that could not be reached.

Type

MutableSequence[str]

class google.cloud.ids_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the metadata of the long-running operation.

create_time

Output only. The time the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. The time the operation finished running.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Output only. Server-defined resource path for the target of the operation.

Type

str

verb

Output only. Name of the verb executed by the operation.

Type

str

status_message

Output only. Human-readable status of the operation, if any.

Type

str

requested_cancellation

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

Type

bool

api_version

Output only. API version used to start the operation.

Type

str