Types for Google Cloud Apigeeconnect v1 API¶
- class google.cloud.apigeeconnect_v1.types.Action(value)[source]¶
Bases:
proto.enums.Enum
The action taken by agent.
- ACTION_UNSPECIFIED = 0¶
- OPEN_NEW_STREAM = 1¶
- class google.cloud.apigeeconnect_v1.types.Cluster(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
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)[source]¶
Bases:
proto.message.Message
- endpoint¶
The endpoint that the connection is made against. Format:
projects/{project_number}/endpoints/{endpoint}
- Type
str
- cluster¶
Cluster information.
- stream_count¶
The count of streams.
- Type
int
- class google.cloud.apigeeconnect_v1.types.EgressRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
gRPC request payload for tether. .. attribute:: id
Unique identifier for the request.
- type
str
- payload¶
Actual payload to send to agent.
- endpoint¶
Tether Endpoint.
- 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)[source]¶
Bases:
proto.message.Message
gRPC response payload for tether. .. attribute:: id
Unique identifier for the response. Matches the EgressRequest’s id.
- type
str
- http_response¶
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.
- 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)[source]¶
Bases:
proto.message.Message
The http headers. .. attribute:: key
- type
str
- values¶
- Type
Sequence[str]
- class google.cloud.apigeeconnect_v1.types.HttpRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The proto definition of http request. .. attribute:: 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.
- headers¶
The HTTP request headers.
- Type
- body¶
HTTP request body.
- Type
bytes
- class google.cloud.apigeeconnect_v1.types.HttpResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The proto definition of http response. .. attribute:: 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
- 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)[source]¶
Bases:
proto.message.Message
The request for [ListConnections][Management.ListConnections]. .. attribute:: 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)[source]¶
Bases:
proto.message.Message
The response for [ListConnections][Management.ListConnections]. .. attribute:: connections
A list of clients.
- type
Sequence[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
- property raw_page¶
- class google.cloud.apigeeconnect_v1.types.Payload(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Payload for EgressRequest. .. attribute:: http_request
The HttpRequest proto.
- type
google.cloud.apigeeconnect_v1.types.HttpRequest
- stream_info¶
The information of stream.
- action¶
The action taken by agent.
- class google.cloud.apigeeconnect_v1.types.Scheme(value)[source]¶
Bases:
proto.enums.Enum
HTTP Scheme.
- HTTPS = 1¶
- SCHEME_UNSPECIFIED = 0¶
- class google.cloud.apigeeconnect_v1.types.StreamInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The Information of bi-directional stream. .. attribute:: id
Unique identifier for the stream.
- type
str
- class google.cloud.apigeeconnect_v1.types.TetherEndpoint(value)[source]¶
Bases:
proto.enums.Enum
Endpoint indicates where the messages will be delivered.
- APIGEE_MART = 1¶
- APIGEE_MINT_RATING = 3¶
- APIGEE_RUNTIME = 2¶
- TETHER_ENDPOINT_UNSPECIFIED = 0¶
- class google.cloud.apigeeconnect_v1.types.Url(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
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.
- host¶
Host or Host:Port.
- Type
str
- path¶
Path starts with
/
.- Type
str