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 Apigeeconnect v1 API

class google.cloud.apigeeconnect_v1.types.Action(value)

Bases: proto.enums.Enum

The action taken by agent.

Values:

ACTION_UNSPECIFIED (0):

Unspecified Action.

OPEN_NEW_STREAM (1):

Indicates that agent should open a new stream.

class google.cloud.apigeeconnect_v1.types.Cluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

name

The name of the cluster.

Type

str

region

The region of the cluster.

Type

str

class google.cloud.apigeeconnect_v1.types.Connection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

endpoint

The endpoint that the connection is made against. Format: projects/{project_number}/endpoints/{endpoint}

Type

str

cluster

Cluster information.

Type

google.cloud.apigeeconnect_v1.types.Cluster

stream_count

The count of streams.

Type

int

class google.cloud.apigeeconnect_v1.types.EgressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

gRPC request payload for tether.

id

Unique identifier for the request.

Type

str

payload

Actual payload to send to agent.

Type

google.cloud.apigeeconnect_v1.types.Payload

endpoint

Tether Endpoint.

Type

google.cloud.apigeeconnect_v1.types.TetherEndpoint

project

GCP Project. Format: projects/{project_number}.

Type

str

trace_id

Unique identifier for clients to trace their request/response.

Type

str

timeout

Timeout for the HTTP request.

Type

google.protobuf.duration_pb2.Duration

class google.cloud.apigeeconnect_v1.types.EgressResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

gRPC response payload for tether.

id

Unique identifier for the response. Matches the EgressRequest’s id.

Type

str

http_response

HttpResponse.

Type

google.cloud.apigeeconnect_v1.types.HttpResponse

status

Errors from application when handling the http request.

Type

google.rpc.status_pb2.Status

project

GCP Project. Format: projects/{project_number}.

Type

str

trace_id

Unique identifier for clients to trace their request/response. Matches the EgressRequest’s trace id

Type

str

endpoint

Tether Endpoint.

Type

google.cloud.apigeeconnect_v1.types.TetherEndpoint

name

Name is the full resource path of endpoint. Format: projects/{project_number or project_id}/endpoints/{endpoint}

Type

str

class google.cloud.apigeeconnect_v1.types.Header(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The http headers.

key

Type

str

values

Type

MutableSequence[str]

class google.cloud.apigeeconnect_v1.types.HttpRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The proto definition of http request.

id

A unique identifier for the request.

Type

str

method

The HTTP request method. Valid methods: “GET”, “HEAD”, “POST”, “PUT”, “PATCH”,”DELETE”.

Type

str

url

The HTTP request URL.

Type

google.cloud.apigeeconnect_v1.types.Url

headers

The HTTP request headers.

Type

MutableSequence[google.cloud.apigeeconnect_v1.types.Header]

body

HTTP request body.

Type

bytes

class google.cloud.apigeeconnect_v1.types.HttpResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The proto definition of http response.

id

A unique identifier that matches the request ID.

Type

str

status

Status of http response, e.g. “200 OK”.

Type

str

status_code

Status code of http response, e.g. 200.

Type

int

body

The HTTP 1.1 response body.

Type

bytes

headers

The HTTP response headers.

Type

MutableSequence[google.cloud.apigeeconnect_v1.types.Header]

content_length

Content length records the length of the associated content. The value -1 indicates that the length is unknown. Unless http method is “HEAD”, values >= 0 indicate that the given number of bytes may be read from Body.

Type

int

class google.cloud.apigeeconnect_v1.types.ListConnectionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request for [ListConnections][Management.ListConnections].

parent

Required. Parent name of the form: projects/{project_number or project_id}/endpoints/{endpoint}.

Type

str

page_size

The maximum number of connections to return. The service may return fewer than this value. If unspecified, at most 100 connections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type

int

page_token

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

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

Type

str

class google.cloud.apigeeconnect_v1.types.ListConnectionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response for [ListConnections][Management.ListConnections].

connections

A list of clients.

Type

MutableSequence[google.cloud.apigeeconnect_v1.types.Connection]

next_page_token

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

Type

str

class google.cloud.apigeeconnect_v1.types.Payload(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Payload for EgressRequest.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

http_request

The HttpRequest proto.

This field is a member of oneof kind.

Type

google.cloud.apigeeconnect_v1.types.HttpRequest

stream_info

The information of stream.

This field is a member of oneof kind.

Type

google.cloud.apigeeconnect_v1.types.StreamInfo

action

The action taken by agent.

This field is a member of oneof kind.

Type

google.cloud.apigeeconnect_v1.types.Action

class google.cloud.apigeeconnect_v1.types.Scheme(value)

Bases: proto.enums.Enum

HTTP Scheme.

Values:

SCHEME_UNSPECIFIED (0):

Unspecified scheme.

HTTPS (1):

HTTPS protocol.

class google.cloud.apigeeconnect_v1.types.StreamInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Information of bi-directional stream.

id

Unique identifier for the stream.

Type

str

class google.cloud.apigeeconnect_v1.types.TetherEndpoint(value)

Bases: proto.enums.Enum

Endpoint indicates where the messages will be delivered.

Values:

TETHER_ENDPOINT_UNSPECIFIED (0):

Unspecified tether endpoint.

APIGEE_MART (1):

Apigee MART endpoint.

APIGEE_RUNTIME (2):

Apigee Runtime endpoint.

APIGEE_MINT_RATING (3):

Apigee Mint Rating endpoint.

class google.cloud.apigeeconnect_v1.types.Url(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The proto definition of url. A url represents a URL and the general form represented is:

[scheme://][google.cloud.apigeeconnect.v1.Url.host][path]

scheme

Scheme.

Type

google.cloud.apigeeconnect_v1.types.Scheme

host

Host or Host:Port.

Type

str

path

Path starts with /.

Type

str