Blame - docs/dyn/servicecontrol_v2.services.html - platform/external/python/google-api-python-client

2020-11-26 17:16:03 -0800

[diff] [blame]

97

"serviceConfigId": "A String", # Specifies the version of the service configuration that should be used to process the request. Must not be empty. Set this field to 'latest' to specify using the latest configuration.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

98

"attributes": { # This message defines the standard attribute vocabulary for Google APIs. An attribute is a piece of metadata that describes an activity on a network service. For example, the size of an HTTP request, or the status code of an HTTP response. Each attribute has a type and a name, which is logically defined as a proto message field in `AttributeContext`. The field type becomes the attribute type, and the field path becomes the attribute name. For example, the attribute `source.ip` maps to field `AttributeContext.source.ip`. This message definition is guaranteed not to have any wire breaking change. So you can use it directly for passing attributes across different systems. NOTE: Different system may generate different subset of attributes. Please verify the system specification before relying on an attribute generated a system. # Describes attributes about the operation being executed by the service.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

99

"request": { # This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request. # Represents a network request, such as an HTTP request.

100

"time": "A String", # The timestamp when the `destination` service receives the first byte of the request.

101

"method": "A String", # The HTTP request method, such as `GET`, `POST`.

102

"protocol": "A String", # The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.

103

"id": "A String", # The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.

104

"host": "A String", # The HTTP request `Host` header value.

105

"query": "A String", # The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears in the first line of the HTTP request. No decoding is performed.

106

"headers": { # The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

107

"a_key": "A String",

108

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

109

"path": "A String", # The HTTP URL path.

110

"scheme": "A String", # The HTTP URL scheme, such as `http` and `https`.

111

"reason": "A String", # A special parameter for request reason. It is used by security systems to associate auditing information with a request.

112

"size": "A String", # The HTTP request size in bytes. If unknown, it must be -1.

113

"auth": { # This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards. # The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request `Authorization` header or equivalent.

114

"accessLevels": [ # A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" Example: "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"

115

"A String",

116

],

117

"claims": { # Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.

118

"a_key": "", # Properties of the object.

119

},

120

"presenter": "A String", # The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com".

121

"audiences": [ # The intended audience(s) for this authentication information. Reflects the audience (`aud`) claim within a JWT. The audience value(s) depends on the `issuer`, but typically include one or more of the following pieces of information: * The services intended to receive the credential. For example, ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"]. * A set of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud-platform"]. * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided.

122

"A String",

123

],

124

"principal": "A String", # The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}"

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

125

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

126

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

127

"extensions": [ # Supports extensions for advanced use cases, such as logs and metrics.

128

{

129

"a_key": "", # Properties of the object. Contains field @type with type URL.

130

},

131

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

132

"source": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop.

133

"principal": "A String", # The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.

134

"port": "A String", # The network port of the peer.

135

"labels": { # The labels associated with the peer.

136

"a_key": "A String",

137

},

138

"ip": "A String", # The IP address of the peer.

139

"regionCode": "A String", # The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running.

140

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

141

"response": { # This message defines attributes for a typical network response. It generally models semantics of an HTTP response. # Represents a network response, such as an HTTP response.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

142

"size": "A String", # The HTTP response size in bytes. If unknown, it must be -1.

143

"code": "A String", # The HTTP response status code, such as `200` and `404`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

144

"time": "A String", # The timestamp when the `destination` service generates the first byte of the response.

145

"headers": { # The HTTP response headers. If multiple headers share the same key, they must be merged according to HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

146

"a_key": "A String",

147

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

148

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

149

"api": { # This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI. # Represents an API operation that is involved to a network activity.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

150

"service": "A String", # The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

151

"protocol": "A String", # The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

152

"version": "A String", # The API version associated with the API operation above, such as "v1" or "v1alpha1".

153

"operation": "A String", # The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the `operationId`, such as "getPet".

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

154

},

155

"resource": { # This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service. # Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.

156

"labels": { # The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.

157

"a_key": "A String",

158

},

159

"createTime": "A String", # Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.

160

"uid": "A String", # The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

161

"service": "A String", # The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request.

162

"etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

163

"updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

164

"type": "A String", # The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service}/{kind}".

165

"displayName": "A String", # Mutable. The display name set by clients. Must be <= 63 characters.

166

"deleteTime": "A String", # Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.

167

"annotations": { # Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

168

"a_key": "A String",

169

},

170

"name": "A String", # The stable identifier (name) of a resource on the `service`. A resource can be logically identified as "//{resource.service}/{resource.name}". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

171

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

172

"origin": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The origin of a network activity. In a multi hop network activity, the origin represents the sender of the first hop. For the first hop, the `source` and the `origin` must have the same content.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

173

"principal": "A String", # The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

174

"port": "A String", # The network port of the peer.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

175

"labels": { # The labels associated with the peer.

176

"a_key": "A String",

177

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

178

"ip": "A String", # The IP address of the peer.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

179

"regionCode": "A String", # The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running.

180

},

181

"destination": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop.

182

"principal": "A String", # The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.

183

"port": "A String", # The network port of the peer.

184

"labels": { # The labels associated with the peer.

185

"a_key": "A String",

186

},

187

"ip": "A String", # The IP address of the peer.

188

"regionCode": "A String", # The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

189

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

190

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

191

"resources": [ # Describes the resources and the policies applied to each resource.

192

{ # Describes a resource referenced in the request.

193

"type": "A String", # The resource type in the format of "{service}/{kind}".

194

"name": "A String", # The name of the resource referenced in the request.

195

"permission": "A String", # The resource permission needed for this request. The format must be "{service}/{plural}.{verb}".

196

},

197

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

198

}

199

200

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

207

208

{ # Response message for the Check method.

209

"status": { # 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). # An 'OK' status allows the operation. Any other status indicates a denial; [google.rpc.Status.details]() would contain additional details about the denial.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

210

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

211

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

212

{

213

"a_key": "", # Properties of the object. Contains field @type with type URL.

214

},

215

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

216

"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.

217

},

218

"headers": { # Returns a set of request contexts generated from the `CheckRequest`.

219

"a_key": "A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

},

}</pre>

</div>

<code class="details" id="close">close()</code>

226

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="report">report(serviceName, body=None, x__xgafv=None)</code>

231

<pre>Private Preview. This feature is only available for approved services. This method provides telemetry reporting for services that are integrated with [Service Infrastructure](/service-infrastructure). It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see [Telemetry Reporting](/service-infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call. This method requires the `servicemanagement.services.report` permission on the specified service. For more information, see [Service Control API Access Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).

232

233

Args:

234

serviceName: string, The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service) for the definition of a service name. (required)

235

body: object, The request body.

236

The object takes the form of:

237

238

{ # Request message for the Report method.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

239

"serviceConfigId": "A String", # Specifies the version of the service configuration that should be used to process the request. Must not be empty. Set this field to 'latest' to specify using the latest configuration.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

240

"operations": [ # Describes the list of operations to be reported. Each operation is represented as an AttributeContext, and contains all attributes around an API access.

241

{ # This message defines the standard attribute vocabulary for Google APIs. An attribute is a piece of metadata that describes an activity on a network service. For example, the size of an HTTP request, or the status code of an HTTP response. Each attribute has a type and a name, which is logically defined as a proto message field in `AttributeContext`. The field type becomes the attribute type, and the field path becomes the attribute name. For example, the attribute `source.ip` maps to field `AttributeContext.source.ip`. This message definition is guaranteed not to have any wire breaking change. So you can use it directly for passing attributes across different systems. NOTE: Different system may generate different subset of attributes. Please verify the system specification before relying on an attribute generated a system.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

242

"request": { # This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request. # Represents a network request, such as an HTTP request.

243

"time": "A String", # The timestamp when the `destination` service receives the first byte of the request.

244

"method": "A String", # The HTTP request method, such as `GET`, `POST`.

245

"protocol": "A String", # The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.

246

"id": "A String", # The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.

247

"host": "A String", # The HTTP request `Host` header value.

248

"query": "A String", # The HTTP URL query in the format of `name1=value1&name2=value2`, as it appears in the first line of the HTTP request. No decoding is performed.

249

"headers": { # The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

250

"a_key": "A String",

251

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

252

"path": "A String", # The HTTP URL path.

253

"scheme": "A String", # The HTTP URL scheme, such as `http` and `https`.

254

"reason": "A String", # A special parameter for request reason. It is used by security systems to associate auditing information with a request.

255

"size": "A String", # The HTTP request size in bytes. If unknown, it must be -1.

256

"auth": { # This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards. # The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request `Authorization` header or equivalent.

257

"accessLevels": [ # A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" Example: "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"

258

"A String",

259

],

260

"claims": { # Structured claims presented with the credential. JWTs include `{key: value}` pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.

261

"a_key": "", # Properties of the object.

262

},

263

"presenter": "A String", # The authorized presenter of the credential. Reflects the optional Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com".

264

"audiences": [ # The intended audience(s) for this authentication information. Reflects the audience (`aud`) claim within a JWT. The audience value(s) depends on the `issuer`, but typically include one or more of the following pieces of information: * The services intended to receive the credential. For example, ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"]. * A set of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud-platform"]. * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided.

265

"A String",

266

],

267

"principal": "A String", # The authenticated principal. Reflects the issuer (`iss`) and subject (`sub`) claims within a JWT. The issuer and subject should be `/` delimited, with `/` percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}"

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

268

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

269

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

270

"extensions": [ # Supports extensions for advanced use cases, such as logs and metrics.

271

{

272

"a_key": "", # Properties of the object. Contains field @type with type URL.

273

},

274

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

275

"source": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The source of a network activity, such as starting a TCP connection. In a multi hop network activity, the source represents the sender of the last hop.

276

"principal": "A String", # The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.

277

"port": "A String", # The network port of the peer.

278

"labels": { # The labels associated with the peer.

279

"a_key": "A String",

280

},

281

"ip": "A String", # The IP address of the peer.

282

"regionCode": "A String", # The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running.

283

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

284

"response": { # This message defines attributes for a typical network response. It generally models semantics of an HTTP response. # Represents a network response, such as an HTTP response.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

285

"size": "A String", # The HTTP response size in bytes. If unknown, it must be -1.

286

"code": "A String", # The HTTP response status code, such as `200` and `404`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

287

"time": "A String", # The timestamp when the `destination` service generates the first byte of the response.

288

"headers": { # The HTTP response headers. If multiple headers share the same key, they must be merged according to HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

289

"a_key": "A String",

290

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

291

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

292

"api": { # This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI. # Represents an API operation that is involved to a network activity.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

293

"service": "A String", # The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

294

"protocol": "A String", # The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

295

"version": "A String", # The API version associated with the API operation above, such as "v1" or "v1alpha1".

296

"operation": "A String", # The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the `operationId`, such as "getPet".

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

297

},

298

"resource": { # This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service. # Represents a target resource that is involved with a network activity. If multiple resources are involved with an activity, this must be the primary one.

299

"labels": { # The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.

300

"a_key": "A String",

301

},

302

"createTime": "A String", # Output only. The timestamp when the resource was created. This may be either the time creation was initiated or when it was completed.

303

"uid": "A String", # The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4.

304

"service": "A String", # The name of the service that this resource belongs to, such as `pubsub.googleapis.com`. The service may be different from the DNS hostname that actually serves the request.

305

"etag": "A String", # Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

306

"updateTime": "A String", # Output only. The timestamp when the resource was last updated. Any change to the resource made by users must refresh this value. Changes to a resource made by the service should refresh this value.

307

"type": "A String", # The type of the resource. The syntax is platform-specific because different platforms define their resources differently. For Google APIs, the type format must be "{service}/{kind}".

308

"displayName": "A String", # Mutable. The display name set by clients. Must be <= 63 characters.

309

"deleteTime": "A String", # Output only. The timestamp when the resource was deleted. If the resource is not deleted, this must be empty.

310

"annotations": { # Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

311

"a_key": "A String",

312

},

313

"name": "A String", # The stable identifier (name) of a resource on the `service`. A resource can be logically identified as "//{resource.service}/{resource.name}". The differences between a resource name and a URI are: * Resource name is a logical identifier, independent of network protocol and API version. For example, `//pubsub.googleapis.com/projects/123/topics/news-feed`. * URI often includes protocol and version information, so it can be used directly by applications. For example, `https://pubsub.googleapis.com/v1/projects/123/topics/news-feed`. See https://cloud.google.com/apis/design/resource_names for details.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

314

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame]

315

"origin": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The origin of a network activity. In a multi hop network activity, the origin represents the sender of the first hop. For the first hop, the `source` and the `origin` must have the same content.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

316

"principal": "A String", # The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

317

"port": "A String", # The network port of the peer.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

318

"labels": { # The labels associated with the peer.

319

"a_key": "A String",

320

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

321

"ip": "A String", # The IP address of the peer.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

322

"regionCode": "A String", # The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running.

323

},

324

"destination": { # This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in `principal` and `labels` as appropriate. # The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop.

325

"principal": "A String", # The identity of this peer. Similar to `Request.auth.principal`, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.

326

"port": "A String", # The network port of the peer.

327

"labels": { # The labels associated with the peer.

328

"a_key": "A String",

329

},

330

"ip": "A String", # The IP address of the peer.

331

"regionCode": "A String", # The CLDR country/region code associated with the above IP address. If the IP address is private, the `region_code` should reflect the physical location where this peer is running.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

332

},

Dmitry Frenkel