Blame - docs/dyn/run_v1alpha1.namespaces.triggers.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Creates a new trigger.</p>

80

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

81

<code><a href="#delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">Rpc to delete a trigger.</p>

83

84

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Rpc to get information about a trigger.</p>

86

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

87

<code><a href="#list">list(parent, watch=None, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Rpc to list triggers.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

89

<h3>Method Details</h3>

90

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

91

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

<pre>Creates a new trigger.

93

94

Args:

95

parent: string, The project ID or project number in which this trigger should

96

be created. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

97

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

98

The object takes the form of:

99

100

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

101

"status": { # TriggerStatus represents the current state of a Trigger. # Optional. Status represents the current state of the Trigger. This data may be out of

102

# date.

103

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Trigger that

104

# was last processed by the controller.

105

"subscriberUri": "A String", # SubscriberURI is the resolved URI of the receiver for this Trigger.

106

"conditions": [ # Array of observed TriggerConditions, indicating the current state

107

# of the Trigger.

108

{ # TriggerCondition contains state information for an Trigger.

109

"status": "A String", # Status of the condition, one of True, False, Unknown.

110

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

111

"reason": "A String", # Optional. One-word CamelCase reason for the condition's current status.

112

"type": "A String", # Type of Trigger condition.

113

"message": "A String", # Optional. Human readable message indicating details about the current status.

114

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

},

],

},

"apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1".

119

"spec": { # The desired state of the Trigger. # Spec defines the desired state of the Trigger.

120

"broker": "A String", # Broker is the broker that this trigger receives events from. If not

121

# specified, will default to 'default'.

122

#

123

# Not currently supported by Cloud Run.

124

"filter": { # Optional. Filter is the filter to apply against all events from the Broker. Only

125

# events that pass this filter will be sent to the Subscriber.

126

# Note that filter is optional in knative and is only required in fully

127

# managed due to different broker implementation.

128

"attributes": { # Optional. Attributes filters events by exact match on event context attributes.

129

# Each key in the map is compared with the equivalent key in the event

130

# context. An event passes the filter if all values are equal to the

131

# specified values.

132

#

133

# Nested context attributes are not supported as keys.

134

# Only string values are supported.

135

# Note that this field is optional in knative. In fully managed, 'type'

136

# attribute is required due to different broker implementation.

"a_key": "A String",

},

},

"subscriber": { # Sink is the addressable that will receive events.

141

"uri": "A String", # URI is for direct URI Designations or used with the resulting URL from

142

# Addressable ObjectReference. If used with an ObjectReference, will be

143

# appended to the path of the resulting URL from the Addressable.

144

# + optional

145

"ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.

146

# + optional

147

# referred object.

148

"apiVersion": "A String", # API version of the referent.

149

# +optional

150

"resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.

151

# More info:

152

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

153

# +optional

154

"name": "A String", # Name of the referent.

155

# More info:

156

# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

157

# +optional

158

"uid": "A String", # UID of the referent.

159

# More info:

160

# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

161

# +optional

162

"fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this

163

# string should contain a valid JSON/Go field access statement, such as

164

# desiredState.manifest.containers[2]. For example, if the object reference

165

# is to a container within a pod, this would take on a value like:

166

# "spec.containers{name}" (where "name" refers to the name of the container

167

# that triggered the event) or if no container name is specified

168

# "spec.containers[2]" (container with index 2 in this pod). This syntax is

169

# chosen only to have some well-defined way of referencing a part of an

170

# object.

171

"namespace": "A String", # Namespace of the referent.

172

# More info:

173

# https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

174

# +optional

175

"kind": "A String", # Kind of the referent.

176

# More info:

177

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

# +optional

},

},

},

"kind": "A String", # The kind of resource, in this case "Trigger".

183

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Trigger.

184

# all objects users must create.

185

"annotations": { # Annotations is an unstructured key value map stored with a resource that

186

# may be set by external tools to store and retrieve arbitrary metadata. They

187

# are not queryable and should be preserved when modifying objects. More

188

# info: http://kubernetes.io/docs/user-guide/annotations +optional

189

"a_key": "A String",

190

},

191

"generateName": "A String", # Not currently supported by Cloud Run.

192

#

193

# GenerateName is an optional prefix, used by the server, to generate a

194

# unique name ONLY IF the Name field has not been provided. If this field is

195

# used, the name returned to the client will be different than the name

196

# passed. This value will also be combined with a unique suffix. The provided

197

# value has the same validation rules as the Name field, and may be truncated

198

# by the length of the suffix required to make the value unique on the

199

# server.

200

#

201

# If this field is specified and the generated name exists, the server will

202

# NOT return a 409 - instead, it will either return 201 Created or 500 with

203

# Reason ServerTimeout indicating a unique name could not be found in the

204

# time allotted, and the client should retry (optionally after the time

205

# indicated in the Retry-After header).

206

#

207

# Applied only if Name is not specified.

208

# More info:

209

# https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

210

# +optional

211

# string generateName = 2;

212

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region.

213

# Is required when creating

214

# resources, although some resources may allow a client to request the

215

# generation of an appropriate name automatically. Name is primarily intended

216

# for creation idempotence and configuration definition. Cannot be updated.

217

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

218

# +optional

219

"clusterName": "A String", # Not currently supported by Cloud Run.

220

#

221

# The name of the cluster which the object belongs to.

222

# This is used to distinguish resources with same name and namespace in

223

# different clusters. This field is not set anywhere right now and apiserver

224

# is going to ignore it if set in create or update request. +optional

225

"deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.

226

#

227

# Number of seconds allowed for this object to gracefully terminate before

228

# it will be removed from the system. Only set when deletionTimestamp is also

229

# set. May only be shortened. Read-only. +optional

230

"finalizers": [ # Not currently supported by Cloud Run.

231

#

232

# Must be empty before the object is deleted from the registry. Each entry

233

# is an identifier for the responsible component that will remove the entry

234

# from the list. If the deletionTimestamp of the object is non-nil, entries

235

# in this list can only be removed.

236

# +optional

237

# +patchStrategy=merge

238

"A String",

239

],

240

"deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be

241

# deleted. This field is set by the server when a graceful deletion is

242

# requested by the user, and is not directly settable by a client. The

243

# resource is expected to be deleted (no longer visible from resource lists,

244

# and not reachable by name) after the time in this field, once the

245

# finalizers list is empty. As long as the finalizers list contains items,

246

# deletion is blocked. Once the deletionTimestamp is set, this value may not

247

# be unset or be set further into the future, although it may be shortened or

248

# the resource may be deleted prior to this time. For example, a user may

249

# request that a pod is deleted in 30 seconds. The Kubelet will react by

250

# sending a graceful termination signal to the containers in the pod. After

251

# that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)

252

# to the container and after cleanup, remove the pod from the API. In the

253

# presence of network partitions, this object may still exist after this

254

# timestamp, until an administrator or automated process can determine the

255

# resource is fully terminated.

256

# If not set, graceful deletion of the object has not been requested.

257

#

258

# Populated by the system when a graceful deletion is requested.

259

# Read-only.

260

# More info:

261

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

262

# +optional

263

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have

264

# been deleted, this object will be garbage collected.

265

# +optional

266

{ # OwnerReference contains enough information to let you identify an owning

267

# object. Currently, an owning object must be in the same namespace, so there

268

# is no namespace field.

269

"apiVersion": "A String", # API version of the referent.

270

"name": "A String", # Name of the referent.

271

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

272

"uid": "A String", # UID of the referent.

273

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

274

"controller": True or False, # If true, this reference points to the managing controller.

275

# +optional

276

"kind": "A String", # Kind of the referent.

277

# More info:

278

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

279

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then

280

# the owner cannot be deleted from the key-value store until this

281

# reference is removed.

282

# Defaults to false.

283

# To set this field, a user needs "delete" permission of the owner,

284

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

"creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this

289

# object was created. It is not guaranteed to be set in happens-before order

290

# across separate operations. Clients may not set this value. It is

291

# represented in RFC3339 form and is in UTC.

292

#

293

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

298

# +optional

299

"labels": { # Map of string keys and values that can be used to organize and categorize

300

# (scope and select) objects. May match selectors of replication controllers

301

# and routes.

302

# More info: http://kubernetes.io/docs/user-guide/labels

# +optional

"a_key": "A String",

},

"generation": 42, # A sequence number representing a specific generation of the desired state.

307

# Populated by the system. Read-only.

308

# +optional

309

"resourceVersion": "A String", # An opaque value that represents the internal version of this object that

310

# can be used by clients to determine when objects have changed. May be used

311

# for optimistic concurrency, change detection, and the watch operation on a

312

# resource or set of resources. Clients must treat these values as opaque and

313

# passed unmodified back to the server. They may only be valid for a

314

# particular resource or set of resources.

315

#

316

# Populated by the system.

317

# Read-only.

318

# Value must be treated as opaque by clients and .

319

# More info:

320

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

321

# +optional

322

"uid": "A String", # UID is the unique in time and space value for this object. It is typically

323

# generated by the server on successful creation of a resource and is not

324

# allowed to change on PUT operations.

325

#

326

# Populated by the system.

327

# Read-only.

328

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

329

# +optional

330

"selfLink": "A String", # SelfLink is a URL representing this object.

331

# Populated by the system.

332

# Read-only.

333

# +optional

334

# string selfLink = 4;

335

"namespace": "A String", # Namespace defines the space within each name must be unique, within a

336

# Cloud Run region. In Cloud Run the namespace must be equal to either the

337

# project ID or project number.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

348

349

{

350

"status": { # TriggerStatus represents the current state of a Trigger. # Optional. Status represents the current state of the Trigger. This data may be out of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

351

# date.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

352

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Trigger that

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

353

# was last processed by the controller.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

354

"subscriberUri": "A String", # SubscriberURI is the resolved URI of the receiver for this Trigger.

355

"conditions": [ # Array of observed TriggerConditions, indicating the current state

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

356

# of the Trigger.

357

{ # TriggerCondition contains state information for an Trigger.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

358

"status": "A String", # Status of the condition, one of True, False, Unknown.

359

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

360

"reason": "A String", # Optional. One-word CamelCase reason for the condition's current status.

361

"type": "A String", # Type of Trigger condition.

362

"message": "A String", # Optional. Human readable message indicating details about the current status.

363

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

364

},

365

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

366

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

367

"apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1".

368

"spec": { # The desired state of the Trigger. # Spec defines the desired state of the Trigger.

369

"broker": "A String", # Broker is the broker that this trigger receives events from. If not

370

# specified, will default to 'default'.

371

#

372

# Not currently supported by Cloud Run.

373

"filter": { # Optional. Filter is the filter to apply against all events from the Broker. Only

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

374

# events that pass this filter will be sent to the Subscriber.

375

# Note that filter is optional in knative and is only required in fully

376

# managed due to different broker implementation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

377

"attributes": { # Optional. Attributes filters events by exact match on event context attributes.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

378

# Each key in the map is compared with the equivalent key in the event

379

# context. An event passes the filter if all values are equal to the

380

# specified values.

381

#

382

# Nested context attributes are not supported as keys.

383

# Only string values are supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

384

# Note that this field is optional in knative. In fully managed, 'type'

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

385

# attribute is required due to different broker implementation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

386

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

387

},

388

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

389

"subscriber": { # Sink is the addressable that will receive events.

390

"uri": "A String", # URI is for direct URI Designations or used with the resulting URL from

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

391

# Addressable ObjectReference. If used with an ObjectReference, will be

392

# appended to the path of the resulting URL from the Addressable.

393

# + optional

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

394

"ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.

395

# + optional

396

# referred object.

397

"apiVersion": "A String", # API version of the referent.

398

# +optional

399

"resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.

400

# More info:

401

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

402

# +optional

403

"name": "A String", # Name of the referent.

404

# More info:

405

# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

406

# +optional

407

"uid": "A String", # UID of the referent.

408

# More info:

409

# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

410

# +optional

411

"fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this

412

# string should contain a valid JSON/Go field access statement, such as

413

# desiredState.manifest.containers[2]. For example, if the object reference

414

# is to a container within a pod, this would take on a value like:

415

# "spec.containers{name}" (where "name" refers to the name of the container

416

# that triggered the event) or if no container name is specified

417

# "spec.containers[2]" (container with index 2 in this pod). This syntax is

418

# chosen only to have some well-defined way of referencing a part of an

419

# object.

420

"namespace": "A String", # Namespace of the referent.

421

# More info:

422

# https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

423

# +optional

424

"kind": "A String", # Kind of the referent.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

425

# More info:

426

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

427

# +optional

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

428

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

429

},

430

},

431

"kind": "A String", # The kind of resource, in this case "Trigger".

432

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Trigger.

433

# all objects users must create.

434

"annotations": { # Annotations is an unstructured key value map stored with a resource that

435

# may be set by external tools to store and retrieve arbitrary metadata. They

436

# are not queryable and should be preserved when modifying objects. More

437

# info: http://kubernetes.io/docs/user-guide/annotations +optional

438

"a_key": "A String",

439

},

440

"generateName": "A String", # Not currently supported by Cloud Run.

441

#

442

# GenerateName is an optional prefix, used by the server, to generate a

443

# unique name ONLY IF the Name field has not been provided. If this field is

444

# used, the name returned to the client will be different than the name

445

# passed. This value will also be combined with a unique suffix. The provided

446

# value has the same validation rules as the Name field, and may be truncated

447

# by the length of the suffix required to make the value unique on the

448

# server.

449

#

450

# If this field is specified and the generated name exists, the server will

451

# NOT return a 409 - instead, it will either return 201 Created or 500 with

452

# Reason ServerTimeout indicating a unique name could not be found in the

453

# time allotted, and the client should retry (optionally after the time

454

# indicated in the Retry-After header).

455

#

456

# Applied only if Name is not specified.

457

# More info:

458

# https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

459

# +optional

460

# string generateName = 2;

461

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

462

# Is required when creating

463

# resources, although some resources may allow a client to request the

464

# generation of an appropriate name automatically. Name is primarily intended

465

# for creation idempotence and configuration definition. Cannot be updated.

466

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

467

# +optional

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

468

"clusterName": "A String", # Not currently supported by Cloud Run.

469

#

470

# The name of the cluster which the object belongs to.

471

# This is used to distinguish resources with same name and namespace in

472

# different clusters. This field is not set anywhere right now and apiserver

473

# is going to ignore it if set in create or update request. +optional

474

"deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.

475

#

476

# Number of seconds allowed for this object to gracefully terminate before

477

# it will be removed from the system. Only set when deletionTimestamp is also

478

# set. May only be shortened. Read-only. +optional

479

"finalizers": [ # Not currently supported by Cloud Run.

480

#

481

# Must be empty before the object is deleted from the registry. Each entry

482

# is an identifier for the responsible component that will remove the entry

483

# from the list. If the deletionTimestamp of the object is non-nil, entries

484

# in this list can only be removed.

485

# +optional

486

# +patchStrategy=merge

487

"A String",

488

],

489

"deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

490

# deleted. This field is set by the server when a graceful deletion is

491

# requested by the user, and is not directly settable by a client. The

492

# resource is expected to be deleted (no longer visible from resource lists,

493

# and not reachable by name) after the time in this field, once the

494

# finalizers list is empty. As long as the finalizers list contains items,

495

# deletion is blocked. Once the deletionTimestamp is set, this value may not

496

# be unset or be set further into the future, although it may be shortened or

497

# the resource may be deleted prior to this time. For example, a user may

498

# request that a pod is deleted in 30 seconds. The Kubelet will react by

499

# sending a graceful termination signal to the containers in the pod. After

500

# that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)

501

# to the container and after cleanup, remove the pod from the API. In the

502

# presence of network partitions, this object may still exist after this

503

# timestamp, until an administrator or automated process can determine the

504

# resource is fully terminated.

505

# If not set, graceful deletion of the object has not been requested.

506

#

507

# Populated by the system when a graceful deletion is requested.

508

# Read-only.

509

# More info:

510

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

511

# +optional

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

512

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have

513

# been deleted, this object will be garbage collected.

514

# +optional

515

{ # OwnerReference contains enough information to let you identify an owning

516

# object. Currently, an owning object must be in the same namespace, so there

517

# is no namespace field.

518

"apiVersion": "A String", # API version of the referent.

519

"name": "A String", # Name of the referent.

520

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

521

"uid": "A String", # UID of the referent.

522

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

523

"controller": True or False, # If true, this reference points to the managing controller.

524

# +optional

525

"kind": "A String", # Kind of the referent.

526

# More info:

527

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

528

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then

529

# the owner cannot be deleted from the key-value store until this

530

# reference is removed.

531

# Defaults to false.

532

# To set this field, a user needs "delete" permission of the owner,

533

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

"creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this

538

# object was created. It is not guaranteed to be set in happens-before order

539

# across separate operations. Clients may not set this value. It is

540

# represented in RFC3339 form and is in UTC.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

541

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

542

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

547

# +optional

548

"labels": { # Map of string keys and values that can be used to organize and categorize

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

549

# (scope and select) objects. May match selectors of replication controllers

550

# and routes.

551

# More info: http://kubernetes.io/docs/user-guide/labels

552

# +optional

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

553

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

554

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

555

"generation": 42, # A sequence number representing a specific generation of the desired state.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

556

# Populated by the system. Read-only.

557

# +optional

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

558

"resourceVersion": "A String", # An opaque value that represents the internal version of this object that

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

559

# can be used by clients to determine when objects have changed. May be used

560

# for optimistic concurrency, change detection, and the watch operation on a

561

# resource or set of resources. Clients must treat these values as opaque and

562

# passed unmodified back to the server. They may only be valid for a

563

# particular resource or set of resources.

564

#

565

# Populated by the system.

566

# Read-only.

567

# Value must be treated as opaque by clients and .

568

# More info:

569

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

570

# +optional

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

571

"uid": "A String", # UID is the unique in time and space value for this object. It is typically

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

572

# generated by the server on successful creation of a resource and is not

573

# allowed to change on PUT operations.

574

#

575

# Populated by the system.

576

# Read-only.

577

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

578

# +optional

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

579

"selfLink": "A String", # SelfLink is a URL representing this object.

580

# Populated by the system.

581

# Read-only.

582

# +optional

583

# string selfLink = 4;

584

"namespace": "A String", # Namespace defines the space within each name must be unique, within a

585

# Cloud Run region. In Cloud Run the namespace must be equal to either the

586

# project ID or project number.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

587

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

588

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

592

<code class="details" id="delete">delete(name, apiVersion=None, propagationPolicy=None, kind=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

593

<pre>Rpc to delete a trigger.

594

595

Args:

596

name: string, The name of the trigger being deleted. If needed, replace

597

{namespace_id} with the project ID. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

598

apiVersion: string, Cloud Run currently ignores this parameter.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

599

propagationPolicy: string, Specifies the propagation policy of delete. Cloud Run currently ignores

600

this setting, and deletes in the background. Please see

601

kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for

602

more information.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

603

kind: string, Cloud Run currently ignores this parameter.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

604

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

611

612

{ # A generic empty message that you can re-use to avoid defining duplicated

613

# empty messages in your APIs. A typical example is to use it as the request

614

# or the response type of an API method. For instance:

615

#

616

# service Foo {

617

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

618

# }

619

#

620

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

626

<pre>Rpc to get information about a trigger.

627

628

Args:

629

name: string, The name of the trigger being retrieved. If needed, replace

630

{namespace_id} with the project ID. (required)

631

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

638

639

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

640

"status": { # TriggerStatus represents the current state of a Trigger. # Optional. Status represents the current state of the Trigger. This data may be out of

641

# date.

642

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Trigger that

643

# was last processed by the controller.

644

"subscriberUri": "A String", # SubscriberURI is the resolved URI of the receiver for this Trigger.

645

"conditions": [ # Array of observed TriggerConditions, indicating the current state

646

# of the Trigger.

647

{ # TriggerCondition contains state information for an Trigger.

648

"status": "A String", # Status of the condition, one of True, False, Unknown.

649

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

650

"reason": "A String", # Optional. One-word CamelCase reason for the condition's current status.

651

"type": "A String", # Type of Trigger condition.

652

"message": "A String", # Optional. Human readable message indicating details about the current status.

653

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

},

],

},

"apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1".

658

"spec": { # The desired state of the Trigger. # Spec defines the desired state of the Trigger.

659

"broker": "A String", # Broker is the broker that this trigger receives events from. If not

660

# specified, will default to 'default'.

661

#

662

# Not currently supported by Cloud Run.

663

"filter": { # Optional. Filter is the filter to apply against all events from the Broker. Only

664

# events that pass this filter will be sent to the Subscriber.

665

# Note that filter is optional in knative and is only required in fully

666

# managed due to different broker implementation.

667

"attributes": { # Optional. Attributes filters events by exact match on event context attributes.

668

# Each key in the map is compared with the equivalent key in the event

669

# context. An event passes the filter if all values are equal to the

670

# specified values.

671

#

672

# Nested context attributes are not supported as keys.

673

# Only string values are supported.

674

# Note that this field is optional in knative. In fully managed, 'type'

675

# attribute is required due to different broker implementation.

676

"a_key": "A String",

677

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

678

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

679

"subscriber": { # Sink is the addressable that will receive events.

680

"uri": "A String", # URI is for direct URI Designations or used with the resulting URL from

681

# Addressable ObjectReference. If used with an ObjectReference, will be

682

# appended to the path of the resulting URL from the Addressable.

683

# + optional

684

"ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.

685

# + optional

686

# referred object.

687

"apiVersion": "A String", # API version of the referent.

688

# +optional

689

"resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.

690

# More info:

691

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

692

# +optional

693

"name": "A String", # Name of the referent.

694

# More info:

695

# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

696

# +optional

697

"uid": "A String", # UID of the referent.

698

# More info:

699

# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

700

# +optional

701

"fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this

702

# string should contain a valid JSON/Go field access statement, such as

703

# desiredState.manifest.containers[2]. For example, if the object reference

704

# is to a container within a pod, this would take on a value like:

705

# "spec.containers{name}" (where "name" refers to the name of the container

706

# that triggered the event) or if no container name is specified

707

# "spec.containers[2]" (container with index 2 in this pod). This syntax is

708

# chosen only to have some well-defined way of referencing a part of an

709

# object.

710

"namespace": "A String", # Namespace of the referent.

711

# More info:

712

# https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

713

# +optional

714

"kind": "A String", # Kind of the referent.

715

# More info:

716

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

717

# +optional

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

718

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

719

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

720

},

721

"kind": "A String", # The kind of resource, in this case "Trigger".

722

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Trigger.

723

# all objects users must create.

724

"annotations": { # Annotations is an unstructured key value map stored with a resource that

725

# may be set by external tools to store and retrieve arbitrary metadata. They

726

# are not queryable and should be preserved when modifying objects. More

727

# info: http://kubernetes.io/docs/user-guide/annotations +optional

728

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

729

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

730

"generateName": "A String", # Not currently supported by Cloud Run.

731

#

732

# GenerateName is an optional prefix, used by the server, to generate a

733

# unique name ONLY IF the Name field has not been provided. If this field is

734

# used, the name returned to the client will be different than the name

735

# passed. This value will also be combined with a unique suffix. The provided

736

# value has the same validation rules as the Name field, and may be truncated

737

# by the length of the suffix required to make the value unique on the

738

# server.

739

#

740

# If this field is specified and the generated name exists, the server will

741

# NOT return a 409 - instead, it will either return 201 Created or 500 with

742

# Reason ServerTimeout indicating a unique name could not be found in the

743

# time allotted, and the client should retry (optionally after the time

744

# indicated in the Retry-After header).

745

#

746

# Applied only if Name is not specified.

747

# More info:

748

# https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

749

# +optional

750

# string generateName = 2;

751

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region.

752

# Is required when creating

753

# resources, although some resources may allow a client to request the

754

# generation of an appropriate name automatically. Name is primarily intended

755

# for creation idempotence and configuration definition. Cannot be updated.

756

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

757

# +optional

758

"clusterName": "A String", # Not currently supported by Cloud Run.

759

#

760

# The name of the cluster which the object belongs to.

761

# This is used to distinguish resources with same name and namespace in

762

# different clusters. This field is not set anywhere right now and apiserver

763

# is going to ignore it if set in create or update request. +optional

764

"deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.

765

#

766

# Number of seconds allowed for this object to gracefully terminate before

767

# it will be removed from the system. Only set when deletionTimestamp is also

768

# set. May only be shortened. Read-only. +optional

769

"finalizers": [ # Not currently supported by Cloud Run.

770

#

771

# Must be empty before the object is deleted from the registry. Each entry

772

# is an identifier for the responsible component that will remove the entry

773

# from the list. If the deletionTimestamp of the object is non-nil, entries

774

# in this list can only be removed.

775

# +optional

776

# +patchStrategy=merge

777

"A String",

778

],

779

"deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be

780

# deleted. This field is set by the server when a graceful deletion is

781

# requested by the user, and is not directly settable by a client. The

782

# resource is expected to be deleted (no longer visible from resource lists,

783

# and not reachable by name) after the time in this field, once the

784

# finalizers list is empty. As long as the finalizers list contains items,

785

# deletion is blocked. Once the deletionTimestamp is set, this value may not

786

# be unset or be set further into the future, although it may be shortened or

787

# the resource may be deleted prior to this time. For example, a user may

788

# request that a pod is deleted in 30 seconds. The Kubelet will react by

789

# sending a graceful termination signal to the containers in the pod. After

790

# that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)

791

# to the container and after cleanup, remove the pod from the API. In the

792

# presence of network partitions, this object may still exist after this

793

# timestamp, until an administrator or automated process can determine the

794

# resource is fully terminated.

795

# If not set, graceful deletion of the object has not been requested.

796

#

797

# Populated by the system when a graceful deletion is requested.

798

# Read-only.

799

# More info:

800

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

801

# +optional

802

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have

803

# been deleted, this object will be garbage collected.

804

# +optional

805

{ # OwnerReference contains enough information to let you identify an owning

806

# object. Currently, an owning object must be in the same namespace, so there

807

# is no namespace field.

808

"apiVersion": "A String", # API version of the referent.

809

"name": "A String", # Name of the referent.

810

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

811

"uid": "A String", # UID of the referent.

812

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

813

"controller": True or False, # If true, this reference points to the managing controller.

814

# +optional

815

"kind": "A String", # Kind of the referent.

816

# More info:

817

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

818

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then

819

# the owner cannot be deleted from the key-value store until this

820

# reference is removed.

821

# Defaults to false.

822

# To set this field, a user needs "delete" permission of the owner,

823

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

"creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this

828

# object was created. It is not guaranteed to be set in happens-before order

829

# across separate operations. Clients may not set this value. It is

830

# represented in RFC3339 form and is in UTC.

831

#

832

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

837

# +optional

838

"labels": { # Map of string keys and values that can be used to organize and categorize

839

# (scope and select) objects. May match selectors of replication controllers

840

# and routes.

841

# More info: http://kubernetes.io/docs/user-guide/labels

# +optional

"a_key": "A String",

},

"generation": 42, # A sequence number representing a specific generation of the desired state.

846

# Populated by the system. Read-only.

847

# +optional

848

"resourceVersion": "A String", # An opaque value that represents the internal version of this object that

849

# can be used by clients to determine when objects have changed. May be used

850

# for optimistic concurrency, change detection, and the watch operation on a

851

# resource or set of resources. Clients must treat these values as opaque and

852

# passed unmodified back to the server. They may only be valid for a

853

# particular resource or set of resources.

854

#

855

# Populated by the system.

856

# Read-only.

857

# Value must be treated as opaque by clients and .

858

# More info:

859

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

860

# +optional

861

"uid": "A String", # UID is the unique in time and space value for this object. It is typically

862

# generated by the server on successful creation of a resource and is not

863

# allowed to change on PUT operations.

864

#

865

# Populated by the system.

866

# Read-only.

867

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

868

# +optional

869

"selfLink": "A String", # SelfLink is a URL representing this object.

870

# Populated by the system.

871

# Read-only.

872

# +optional

873

# string selfLink = 4;

874

"namespace": "A String", # Namespace defines the space within each name must be unique, within a

875

# Cloud Run region. In Cloud Run the namespace must be equal to either the

876

# project ID or project number.

877

},

878

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

882

<code class="details" id="list">list(parent, watch=None, labelSelector=None, resourceVersion=None, includeUninitialized=None, fieldSelector=None, continue=None, limit=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

883

<pre>Rpc to list triggers.

884

885

Args:

886

parent: string, The project ID or project number from which the triggers should

887

be listed. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

888

watch: boolean, Flag that indicates that the client expects to watch this resource as well.

889

Not currently used by Cloud Run.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

890

labelSelector: string, Allows to filter resources based on a label. Supported operations are

891

=, !=, exists, in, and notIn.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

892

resourceVersion: string, The baseline resource version from which the list or watch operation should

893

start. Not currently used by Cloud Run.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

894

includeUninitialized: boolean, Not currently used by Cloud Run.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

895

fieldSelector: string, Allows to filter resources based on a specific value for a field name.

896

Send this in a query string format. i.e. 'metadata.name%3Dlorem'.

897

Not currently used by Cloud Run.

898

continue: string, Optional. Encoded string to continue paging.

899

limit: integer, The maximum number of records that should be returned.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

900

x__xgafv: string, V1 error format.

901

Allowed values

902

1 - v1 error format

903

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

904

905

Returns:

906

An object of the form:

907

908

{ # ListTriggersResponse is a list of Trigger resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

909

"kind": "A String", # The kind of this resource, in this case "TriggerList".

910

"unreachable": [ # Locations that could not be reached.

911

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

912

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

913

"metadata": { # ListMeta describes metadata that synthetic resources must have, including # Metadata associated with this Trigger list.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

914

# lists and various status objects. A resource may have only one of

915

# {ObjectMeta, ListMeta}.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

916

"resourceVersion": "A String", # String that identifies the server's internal version of this object that

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

917

# can be used by clients to determine when objects have changed. Value must

918

# be treated as opaque by clients and passed unmodified back to the server.

919

# Populated by the system.

920

# Read-only.

921

# More info:

922

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

923

# +optional

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

924

"continue": "A String", # continue may be set if the user set a limit on the number of items

925

# returned, and indicates that the server has more data available. The value

926

# is opaque and may be used to issue another request to the endpoint that

927

# served this list to retrieve the next set of available objects. Continuing

928

# a list may not be possible if the server configuration has changed or more

929

# than a few minutes have passed. The resourceVersion field returned when

930

# using this continue value will be identical to the value in the first

931

# response.

932

"selfLink": "A String", # SelfLink is a URL representing this object.

933

# Populated by the system.

934

# Read-only.

935

# +optional

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

936

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

937

"items": [ # List of Triggers.

938

{

939

"status": { # TriggerStatus represents the current state of a Trigger. # Optional. Status represents the current state of the Trigger. This data may be out of

940

# date.

941

"observedGeneration": 42, # ObservedGeneration is the 'Generation' of the Trigger that

942

# was last processed by the controller.

943

"subscriberUri": "A String", # SubscriberURI is the resolved URI of the receiver for this Trigger.

944

"conditions": [ # Array of observed TriggerConditions, indicating the current state

945

# of the Trigger.

946

{ # TriggerCondition contains state information for an Trigger.

947

"status": "A String", # Status of the condition, one of True, False, Unknown.

948

"severity": "A String", # Optional. How to interpret failures of this condition, one of Error, Warning, Info

949

"reason": "A String", # Optional. One-word CamelCase reason for the condition's current status.

950

"type": "A String", # Type of Trigger condition.

951

"message": "A String", # Optional. Human readable message indicating details about the current status.

952

"lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.

},

],

},

"apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1".

957

"spec": { # The desired state of the Trigger. # Spec defines the desired state of the Trigger.

958

"broker": "A String", # Broker is the broker that this trigger receives events from. If not

959

# specified, will default to 'default'.

960

#

961

# Not currently supported by Cloud Run.

962

"filter": { # Optional. Filter is the filter to apply against all events from the Broker. Only

963

# events that pass this filter will be sent to the Subscriber.

964

# Note that filter is optional in knative and is only required in fully

965

# managed due to different broker implementation.

966

"attributes": { # Optional. Attributes filters events by exact match on event context attributes.

967

# Each key in the map is compared with the equivalent key in the event

968

# context. An event passes the filter if all values are equal to the

969

# specified values.

970

#

971

# Nested context attributes are not supported as keys.

972

# Only string values are supported.

973

# Note that this field is optional in knative. In fully managed, 'type'

974

# attribute is required due to different broker implementation.

"a_key": "A String",

},

},

"subscriber": { # Sink is the addressable that will receive events.

979

"uri": "A String", # URI is for direct URI Designations or used with the resulting URL from

980

# Addressable ObjectReference. If used with an ObjectReference, will be

981

# appended to the path of the resulting URL from the Addressable.

982

# + optional

983

"ref": { # ObjectReference contains enough information to let you inspect or modify the # ObjectReference points to an Addressable.

984

# + optional

985

# referred object.

986

"apiVersion": "A String", # API version of the referent.

987

# +optional

988

"resourceVersion": "A String", # Specific resourceVersion to which this reference is made, if any.

989

# More info:

990

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

991

# +optional

992

"name": "A String", # Name of the referent.

993

# More info:

994

# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

995

# +optional

996

"uid": "A String", # UID of the referent.

997

# More info:

998

# https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

999

# +optional

1000

"fieldPath": "A String", # If referring to a piece of an object instead of an entire object, this

1001

# string should contain a valid JSON/Go field access statement, such as

1002

# desiredState.manifest.containers[2]. For example, if the object reference

1003

# is to a container within a pod, this would take on a value like:

1004

# "spec.containers{name}" (where "name" refers to the name of the container

1005

# that triggered the event) or if no container name is specified

1006

# "spec.containers[2]" (container with index 2 in this pod). This syntax is

1007

# chosen only to have some well-defined way of referencing a part of an

1008

# object.

1009

"namespace": "A String", # Namespace of the referent.

1010

# More info:

1011

# https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

1012

# +optional

1013

"kind": "A String", # Kind of the referent.

1014

# More info:

1015

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

# +optional

},

},

},

"kind": "A String", # The kind of resource, in this case "Trigger".

1021

"metadata": { # ObjectMeta is metadata that all persisted resources must have, which includes # Metadata associated with this Trigger.

1022

# all objects users must create.

1023

"annotations": { # Annotations is an unstructured key value map stored with a resource that

1024

# may be set by external tools to store and retrieve arbitrary metadata. They

1025

# are not queryable and should be preserved when modifying objects. More

1026

# info: http://kubernetes.io/docs/user-guide/annotations +optional

1027

"a_key": "A String",

1028

},

1029

"generateName": "A String", # Not currently supported by Cloud Run.

1030

#

1031

# GenerateName is an optional prefix, used by the server, to generate a

1032

# unique name ONLY IF the Name field has not been provided. If this field is

1033

# used, the name returned to the client will be different than the name

1034

# passed. This value will also be combined with a unique suffix. The provided

1035

# value has the same validation rules as the Name field, and may be truncated

1036

# by the length of the suffix required to make the value unique on the

1037

# server.

1038

#

1039

# If this field is specified and the generated name exists, the server will

1040

# NOT return a 409 - instead, it will either return 201 Created or 500 with

1041

# Reason ServerTimeout indicating a unique name could not be found in the

1042

# time allotted, and the client should retry (optionally after the time

1043

# indicated in the Retry-After header).

1044

#

1045

# Applied only if Name is not specified.

1046

# More info:

1047

# https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency

1048

# +optional

1049

# string generateName = 2;

1050

"name": "A String", # Name must be unique within a namespace, within a Cloud Run region.

1051

# Is required when creating

1052

# resources, although some resources may allow a client to request the

1053

# generation of an appropriate name automatically. Name is primarily intended

1054

# for creation idempotence and configuration definition. Cannot be updated.

1055

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

1056

# +optional

1057

"clusterName": "A String", # Not currently supported by Cloud Run.

1058

#

1059

# The name of the cluster which the object belongs to.

1060

# This is used to distinguish resources with same name and namespace in

1061

# different clusters. This field is not set anywhere right now and apiserver

1062

# is going to ignore it if set in create or update request. +optional

1063

"deletionGracePeriodSeconds": 42, # Not currently supported by Cloud Run.

1064

#

1065

# Number of seconds allowed for this object to gracefully terminate before

1066

# it will be removed from the system. Only set when deletionTimestamp is also

1067

# set. May only be shortened. Read-only. +optional

1068

"finalizers": [ # Not currently supported by Cloud Run.

1069

#

1070

# Must be empty before the object is deleted from the registry. Each entry

1071

# is an identifier for the responsible component that will remove the entry

1072

# from the list. If the deletionTimestamp of the object is non-nil, entries

1073

# in this list can only be removed.

1074

# +optional

1075

# +patchStrategy=merge

1076

"A String",

1077

],

1078

"deletionTimestamp": "A String", # DeletionTimestamp is RFC 3339 date and time at which this resource will be

1079

# deleted. This field is set by the server when a graceful deletion is

1080

# requested by the user, and is not directly settable by a client. The

1081

# resource is expected to be deleted (no longer visible from resource lists,

1082

# and not reachable by name) after the time in this field, once the

1083

# finalizers list is empty. As long as the finalizers list contains items,

1084

# deletion is blocked. Once the deletionTimestamp is set, this value may not

1085

# be unset or be set further into the future, although it may be shortened or

1086

# the resource may be deleted prior to this time. For example, a user may

1087

# request that a pod is deleted in 30 seconds. The Kubelet will react by

1088

# sending a graceful termination signal to the containers in the pod. After

1089

# that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL)

1090

# to the container and after cleanup, remove the pod from the API. In the

1091

# presence of network partitions, this object may still exist after this

1092

# timestamp, until an administrator or automated process can determine the

1093

# resource is fully terminated.

1094

# If not set, graceful deletion of the object has not been requested.

1095

#

1096

# Populated by the system when a graceful deletion is requested.

1097

# Read-only.

1098

# More info:

1099

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

1100

# +optional

1101

"ownerReferences": [ # List of objects that own this object. If ALL objects in the list have

1102

# been deleted, this object will be garbage collected.

1103

# +optional

1104

{ # OwnerReference contains enough information to let you identify an owning

1105

# object. Currently, an owning object must be in the same namespace, so there

1106

# is no namespace field.

1107

"apiVersion": "A String", # API version of the referent.

1108

"name": "A String", # Name of the referent.

1109

# More info: http://kubernetes.io/docs/user-guide/identifiers#names

1110

"uid": "A String", # UID of the referent.

1111

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

1112

"controller": True or False, # If true, this reference points to the managing controller.

1113

# +optional

1114

"kind": "A String", # Kind of the referent.

1115

# More info:

1116

# https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

1117

"blockOwnerDeletion": True or False, # If true, AND if the owner has the "foregroundDeletion" finalizer, then

1118

# the owner cannot be deleted from the key-value store until this

1119

# reference is removed.

1120

# Defaults to false.

1121

# To set this field, a user needs "delete" permission of the owner,

1122

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

"creationTimestamp": "A String", # CreationTimestamp is a timestamp representing the server time when this

1127

# object was created. It is not guaranteed to be set in happens-before order

1128

# across separate operations. Clients may not set this value. It is

1129

# represented in RFC3339 form and is in UTC.

1130

#

1131

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

# https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

1136

# +optional

1137

"labels": { # Map of string keys and values that can be used to organize and categorize

1138

# (scope and select) objects. May match selectors of replication controllers

1139

# and routes.

1140

# More info: http://kubernetes.io/docs/user-guide/labels

# +optional

"a_key": "A String",

},

"generation": 42, # A sequence number representing a specific generation of the desired state.

1145

# Populated by the system. Read-only.

1146

# +optional

1147

"resourceVersion": "A String", # An opaque value that represents the internal version of this object that

1148

# can be used by clients to determine when objects have changed. May be used

1149

# for optimistic concurrency, change detection, and the watch operation on a

1150

# resource or set of resources. Clients must treat these values as opaque and

1151

# passed unmodified back to the server. They may only be valid for a

1152

# particular resource or set of resources.

1153

#

1154

# Populated by the system.

1155

# Read-only.

1156

# Value must be treated as opaque by clients and .

1157

# More info:

1158

# https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

1159

# +optional

1160

"uid": "A String", # UID is the unique in time and space value for this object. It is typically

1161

# generated by the server on successful creation of a resource and is not

1162

# allowed to change on PUT operations.

1163

#

1164

# Populated by the system.

1165

# Read-only.

1166

# More info: http://kubernetes.io/docs/user-guide/identifiers#uids

1167

# +optional

1168

"selfLink": "A String", # SelfLink is a URL representing this object.

1169

# Populated by the system.

1170

# Read-only.

1171

# +optional

1172

# string selfLink = 4;

1173

"namespace": "A String", # Namespace defines the space within each name must be unique, within a

1174

# Cloud Run region. In Cloud Run the namespace must be equal to either the

1175

# project ID or project number.

},

},

],

"apiVersion": "A String", # The API version for this call such as "eventing.knative.dev/v1alpha1".

Bu Sun Kim