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

<h1><a href="run_v1alpha1.html">Cloud Run API</a> . <a href="run_v1alpha1.namespaces.html">namespaces</a> . <a href="run_v1alpha1.namespaces.cloudpubsubsources.html">cloudpubsubsources</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

<p class="firstline">Rpc to delete a cloudpubsubsource.</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 cloudpubsubsource.</p>

86

87

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

88

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

89

<h3>Method Details</h3>

90

91

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

92

<pre>Creates a new cloudpubsubsource.

93

94

Args:

95

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

96

be created. (required)

97

body: object, The request body.

98

The object takes the form of:

99

100

{

101

"status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may

102

# be out of date. +optional

103

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

104

# of the CloudPubSubSource.

105

{ # Condition defines a generic condition for a Resource

106

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

107

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

108

"type": "A String", # type is used to communicate the status of the reconciliation process.

109

# See also:

110

# https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

111

# Types common to all resources include:

112

# * "Ready": True when the Resource is ready.

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.

115

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

116

},

117

],

118

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

119

# was last processed by the controller.

120

"sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the

# Source.

# +optional

},

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

125

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

126

"retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If

127

# true, acknowledged messages will not be expunged until they fall out of

128

# the RetentionDuration window.

129

"retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from

130

# the time of publish. If RetainAckedMessages is true, this duration

131

# affects the retention of acknowledged messages, otherwise only

132

# unacknowledged messages are retained. Cannot be longer than 7 days or

133

# shorter than 10 minutes. Defaults to 7 days ('7d').

134

# +optional

135

"ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a

136

# message before the subscriber should acknowledge the message. Defaults

137

# to 30 seconds ('30s').

138

# +optional

139

"ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and

140

# modifications of the event sent to the sink.

141

# +optional

142

# format of the CloudEvents produced by the Source.

143

"extensions": { # Extensions specify what attribute are added or overridden on the outbound

144

# event. Each `Extensions` key-value pair are set on the event as an

145

# attribute extension independently.

# +optional

"a_key": "A String",

},

},

"secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job.

151

# If not specified, defaults to:

152

# Name: google-cloud-key

# Key: key.json

# +optional

#

# Cloud Run on GKE: supported

157

#

158

# SecretKeySelector selects a key of a Secret.

159

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined

160

# directly into the message. Use the "name" field instead.

161

# referenced object inside the same namespace.

162

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

163

# More info:

164

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

165

},

166

"optional": True or False, # Cloud Run fully managed: not supported

167

#

168

# Cloud Run on GKE: supported

169

#

170

# Specify whether the Secret or its key must be defined

171

# +optional

172

"key": "A String", # Cloud Run fully managed: not supported

173

#

174

# Cloud Run on GKE: supported

175

#

176

# The key of the secret to select from. Must be a valid secret key.

177

"name": "A String", # Cloud Run fully managed: not supported

178

#

179

# Cloud Run on GKE: supported

180

#

181

# The name of the secret in the pod's namespace to select from.

182

},

183

"project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource

184

# Topic exists in. If omitted, defaults to same as the cluster. +optional

185

"topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must

186

# be in the form of the unique identifier within the project, not the

187

# entire name. E.g. it must be 'laconia', not

188

# 'projects/my-proj/topics/laconia'.

189

"pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create

190

# Topic / PullSubscription resources. If omitted, uses Secret.

191

#

192

# Cloud Run on GKE: supported

193

#

194

# SecretKeySelector selects a key of a Secret.

195

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined

196

# directly into the message. Use the "name" field instead.

197

# referenced object inside the same namespace.

198

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

199

# More info:

200

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

201

},

202

"optional": True or False, # Cloud Run fully managed: not supported

203

#

204

# Cloud Run on GKE: supported

205

#

206

# Specify whether the Secret or its key must be defined

207

# +optional

208

"key": "A String", # Cloud Run fully managed: not supported

209

#

210

# Cloud Run on GKE: supported

211

#

212

# The key of the secret to select from. Must be a valid secret key.

213

"name": "A String", # Cloud Run fully managed: not supported

214

#

215

# Cloud Run on GKE: supported

216

#

217

# The name of the secret in the pod's namespace to select from.

218

},

219

"sink": { # Sink is a reference to an object that will resolve to a domain name or a

220

# URI directly to use as the sink.

221

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

222

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

223

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

224

# + optional

225

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

226

# + optional

227

# referred object.

228

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

229

# +optional

230

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

231

# More info:

232

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

233

# +optional

234

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

235

# More info:

236

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

237

# +optional

238

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

239

# More info:

240

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

241

# +optional

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

# object.

251

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

252

# More info:

253

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

254

# +optional

255

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

256

# More info:

257

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

# +optional

},

},

},

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

263

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

264

# all objects users must create.

265

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

266

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

267

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

268

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

269

"a_key": "A String",

270

},

271

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

272

#

273

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

274

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

275

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

276

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

277

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

278

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

279

# server.

280

#

281

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

282

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

283

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

284

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

285

# indicated in the Retry-After header).

286

#

287

# Applied only if Name is not specified.

288

# More info:

289

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

290

# +optional

291

# string generateName = 2;

292

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

293

# Is required when creating

294

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

295

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

296

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

297

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

298

# +optional

299

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

300

#

301

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

302

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

303

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

304

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

305

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

306

#

307

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

308

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

309

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

310

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

311

#

312

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

313

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

314

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

315

# in this list can only be removed.

316

# +optional

317

# +patchStrategy=merge

318

"A String",

319

],

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

# resource is fully terminated.

336

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

337

#

338

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

339

# Read-only.

340

# More info:

341

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

342

# +optional

343

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

344

# been deleted, this object will be garbage collected.

345

# +optional

346

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

347

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

348

# is no namespace field.

349

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

350

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

351

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

352

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

353

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

354

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

355

# +optional

356

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

357

# More info:

358

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

359

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

360

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

361

# reference is removed.

362

# Defaults to false.

363

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

364

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

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

369

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

370

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

371

# represented in RFC3339 form and is in UTC.

372

#

373

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

378

# +optional

379

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

380

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

381

# and routes.

382

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

387

# Populated by the system. Read-only.

388

# +optional

389

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

390

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

391

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

392

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

393

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

394

# particular resource or set of resources.

395

#

396

# Populated by the system.

397

# Read-only.

398

# Value must be treated as opaque by clients and .

399

# More info:

400

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

401

# +optional

402

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

403

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

404

# allowed to change on PUT operations.

405

#

406

# Populated by the system.

407

# Read-only.

408

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

409

# +optional

410

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

411

# Populated by the system.

412

# Read-only.

413

# +optional

414

# string selfLink = 4;

415

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

416

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

417

# 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:

428

429

{

430

"status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may

431

# be out of date. +optional

432

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

433

# of the CloudPubSubSource.

434

{ # Condition defines a generic condition for a Resource

435

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

436

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

437

"type": "A String", # type is used to communicate the status of the reconciliation process.

438

# See also:

439

# https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

440

# Types common to all resources include:

441

# * "Ready": True when the Resource is ready.

442

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

443

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

444

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

445

},

446

],

447

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

448

# was last processed by the controller.

449

"sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the

# Source.

# +optional

},

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

454

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

455

"retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If

456

# true, acknowledged messages will not be expunged until they fall out of

457

# the RetentionDuration window.

458

"retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from

459

# the time of publish. If RetainAckedMessages is true, this duration

460

# affects the retention of acknowledged messages, otherwise only

461

# unacknowledged messages are retained. Cannot be longer than 7 days or

462

# shorter than 10 minutes. Defaults to 7 days ('7d').

463

# +optional

464

"ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a

465

# message before the subscriber should acknowledge the message. Defaults

466

# to 30 seconds ('30s').

467

# +optional

468

"ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and

469

# modifications of the event sent to the sink.

470

# +optional

471

# format of the CloudEvents produced by the Source.

472

"extensions": { # Extensions specify what attribute are added or overridden on the outbound

473

# event. Each `Extensions` key-value pair are set on the event as an

474

# attribute extension independently.

# +optional

"a_key": "A String",

},

},

"secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job.

480

# If not specified, defaults to:

481

# Name: google-cloud-key

# Key: key.json

# +optional

#

# Cloud Run on GKE: supported

486

#

487

# SecretKeySelector selects a key of a Secret.

488

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined

489

# directly into the message. Use the "name" field instead.

490

# referenced object inside the same namespace.

491

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

492

# More info:

493

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

494

},

495

"optional": True or False, # Cloud Run fully managed: not supported

496

#

497

# Cloud Run on GKE: supported

498

#

499

# Specify whether the Secret or its key must be defined

500

# +optional

501

"key": "A String", # Cloud Run fully managed: not supported

502

#

503

# Cloud Run on GKE: supported

504

#

505

# The key of the secret to select from. Must be a valid secret key.

506

"name": "A String", # Cloud Run fully managed: not supported

507

#

508

# Cloud Run on GKE: supported

509

#

510

# The name of the secret in the pod's namespace to select from.

511

},

512

"project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource

513

# Topic exists in. If omitted, defaults to same as the cluster. +optional

514

"topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must

515

# be in the form of the unique identifier within the project, not the

516

# entire name. E.g. it must be 'laconia', not

517

# 'projects/my-proj/topics/laconia'.

518

"pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create

519

# Topic / PullSubscription resources. If omitted, uses Secret.

520

#

521

# Cloud Run on GKE: supported

522

#

523

# SecretKeySelector selects a key of a Secret.

524

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined

525

# directly into the message. Use the "name" field instead.

526

# referenced object inside the same namespace.

527

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

528

# More info:

529

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

530

},

531

"optional": True or False, # Cloud Run fully managed: not supported

532

#

533

# Cloud Run on GKE: supported

534

#

535

# Specify whether the Secret or its key must be defined

536

# +optional

537

"key": "A String", # Cloud Run fully managed: not supported

538

#

539

# Cloud Run on GKE: supported

540

#

541

# The key of the secret to select from. Must be a valid secret key.

542

"name": "A String", # Cloud Run fully managed: not supported

543

#

544

# Cloud Run on GKE: supported

545

#

546

# The name of the secret in the pod's namespace to select from.

547

},

548

"sink": { # Sink is a reference to an object that will resolve to a domain name or a

549

# URI directly to use as the sink.

550

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

551

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

552

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

553

# + optional

554

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

555

# + optional

556

# referred object.

557

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

558

# +optional

559

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

560

# More info:

561

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

562

# +optional

563

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

564

# More info:

565

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

566

# +optional

567

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

568

# More info:

569

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

570

# +optional

571

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

572

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

573

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

574

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

575

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

576

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

577

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

578

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

579

# object.

580

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

581

# More info:

582

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

583

# +optional

584

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

585

# More info:

586

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

# +optional

},

},

},

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

592

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

593

# all objects users must create.

594

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

595

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

596

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

597

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

598

"a_key": "A String",

599

},

600

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

601

#

602

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

603

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

604

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

605

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

606

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

607

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

608

# server.

609

#

610

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

611

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

612

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

613

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

614

# indicated in the Retry-After header).

615

#

616

# Applied only if Name is not specified.

617

# More info:

618

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

619

# +optional

620

# string generateName = 2;

621

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

622

# Is required when creating

623

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

624

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

625

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

626

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

627

# +optional

628

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

629

#

630

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

631

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

632

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

633

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

634

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

635

#

636

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

637

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

638

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

639

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

640

#

641

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

642

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

643

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

644

# in this list can only be removed.

645

# +optional

646

# +patchStrategy=merge

647

"A String",

648

],

649

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

650

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

651

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

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

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

663

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

664

# resource is fully terminated.

665

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

666

#

667

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

668

# Read-only.

669

# More info:

670

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

671

# +optional

672

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

673

# been deleted, this object will be garbage collected.

674

# +optional

675

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

676

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

677

# is no namespace field.

678

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

679

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

680

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

681

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

682

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

683

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

684

# +optional

685

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

686

# More info:

687

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

688

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

689

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

690

# reference is removed.

691

# Defaults to false.

692

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

693

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

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

698

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

699

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

700

# represented in RFC3339 form and is in UTC.

701

#

702

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

707

# +optional

708

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

709

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

710

# and routes.

711

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

716

# Populated by the system. Read-only.

717

# +optional

718

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

719

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

720

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

721

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

722

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

723

# particular resource or set of resources.

724

#

725

# Populated by the system.

726

# Read-only.

727

# Value must be treated as opaque by clients and .

728

# More info:

729

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

730

# +optional

731

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

732

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

733

# allowed to change on PUT operations.

734

#

735

# Populated by the system.

736

# Read-only.

737

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

738

# +optional

739

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

740

# Populated by the system.

741

# Read-only.

742

# +optional

743

# string selfLink = 4;

744

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

745

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

746

# project ID or project number.

},

}</pre>

</div>

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

753

<pre>Rpc to delete a cloudpubsubsource.

754

755

Args:

756

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

757

{namespace_id} with the project ID. (required)

758

apiVersion: string, Cloud Run currently ignores this parameter.

759

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

760

this setting, and deletes in the background. Please see

761

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

762

more information.

763

kind: string, Cloud Run currently ignores this parameter.

764

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

771

772

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

773

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

774

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

775

#

776

# service Foo {

777

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

778

# }

779

#

780

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

}</pre>

</div>

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

786

<pre>Rpc to get information about a cloudpubsubsource.

787

788

Args:

789

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

790

{namespace_id} with the project ID. (required)

791

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

798

799

{

800

"status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may

801

# be out of date. +optional

802

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

803

# of the CloudPubSubSource.

804

{ # Condition defines a generic condition for a Resource

805

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

806

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

807

"type": "A String", # type is used to communicate the status of the reconciliation process.

808

# See also:

809

# https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

810

# Types common to all resources include:

811

# * "Ready": True when the Resource is ready.

812

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

813

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

814

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

815

},

816

],

817

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

818

# was last processed by the controller.

819

"sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the

# Source.

# +optional

},

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

824

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

825

"retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If

826

# true, acknowledged messages will not be expunged until they fall out of

827

# the RetentionDuration window.

828

"retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from

829

# the time of publish. If RetainAckedMessages is true, this duration

830

# affects the retention of acknowledged messages, otherwise only

831

# unacknowledged messages are retained. Cannot be longer than 7 days or

832

# shorter than 10 minutes. Defaults to 7 days ('7d').

833

# +optional

834

"ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a

835

# message before the subscriber should acknowledge the message. Defaults

836

# to 30 seconds ('30s').

837

# +optional

838

"ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and

839

# modifications of the event sent to the sink.

840

# +optional

841

# format of the CloudEvents produced by the Source.

842

"extensions": { # Extensions specify what attribute are added or overridden on the outbound

843

# event. Each `Extensions` key-value pair are set on the event as an

844

# attribute extension independently.

# +optional

"a_key": "A String",

},

},

"secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job.

850

# If not specified, defaults to:

851

# Name: google-cloud-key

# Key: key.json

# +optional

#

# Cloud Run on GKE: supported

856

#

857

# SecretKeySelector selects a key of a Secret.

858

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined

859

# directly into the message. Use the "name" field instead.

860

# referenced object inside the same namespace.

861

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

862

# More info:

863

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

864

},

865

"optional": True or False, # Cloud Run fully managed: not supported

866

#

867

# Cloud Run on GKE: supported

868

#

869

# Specify whether the Secret or its key must be defined

870

# +optional

871

"key": "A String", # Cloud Run fully managed: not supported

872

#

873

# Cloud Run on GKE: supported

874

#

875

# The key of the secret to select from. Must be a valid secret key.

876

"name": "A String", # Cloud Run fully managed: not supported

877

#

878

# Cloud Run on GKE: supported

879

#

880

# The name of the secret in the pod's namespace to select from.

881

},

882

"project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource

883

# Topic exists in. If omitted, defaults to same as the cluster. +optional

884

"topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must

885

# be in the form of the unique identifier within the project, not the

886

# entire name. E.g. it must be 'laconia', not

887

# 'projects/my-proj/topics/laconia'.

888

"pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create

889

# Topic / PullSubscription resources. If omitted, uses Secret.

890

#

891

# Cloud Run on GKE: supported

892

#

893

# SecretKeySelector selects a key of a Secret.

894

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined

895

# directly into the message. Use the "name" field instead.

896

# referenced object inside the same namespace.

897

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

898

# More info:

899

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

900

},

901

"optional": True or False, # Cloud Run fully managed: not supported

902

#

903

# Cloud Run on GKE: supported

904

#

905

# Specify whether the Secret or its key must be defined

906

# +optional

907

"key": "A String", # Cloud Run fully managed: not supported

908

#

909

# Cloud Run on GKE: supported

910

#

911

# The key of the secret to select from. Must be a valid secret key.

912

"name": "A String", # Cloud Run fully managed: not supported

913

#

914

# Cloud Run on GKE: supported

915

#

916

# The name of the secret in the pod's namespace to select from.

917

},

918

"sink": { # Sink is a reference to an object that will resolve to a domain name or a

919

# URI directly to use as the sink.

920

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

921

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

922

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

923

# + optional

924

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

925

# + optional

926

# referred object.

927

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

928

# +optional

929

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

930

# More info:

931

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

932

# +optional

933

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

934

# More info:

935

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

936

# +optional

937

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

938

# More info:

939

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

940

# +optional

941

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

942

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

943

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

944

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

945

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

946

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

947

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

948

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

949

# object.

950

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

951

# More info:

952

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

953

# +optional

954

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

955

# More info:

956

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

# +optional

},

},

},

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

962

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

963

# all objects users must create.

964

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

965

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

966

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

967

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

968

"a_key": "A String",

969

},

970

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

971

#

972

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

973

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

974

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

975

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

976

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

977

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

978

# server.

979

#

980

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

981

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

982

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

983

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

984

# indicated in the Retry-After header).

985

#

986

# Applied only if Name is not specified.

987

# More info:

988

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

989

# +optional

990

# string generateName = 2;

991

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

992

# Is required when creating

993

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

994

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

995

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

996

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

997

# +optional

998

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

999

#

1000

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

1001

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

1002

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

1003

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

1004

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

1005

#

1006

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

1007

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

1008

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

1009

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

1010

#

1011

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

1012

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

1013

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

1014

# in this list can only be removed.

1015

# +optional

1016

# +patchStrategy=merge

1017

"A String",

1018

],

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

# resource is fully terminated.

1035

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

1036

#

1037

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

1038

# Read-only.

1039

# More info:

1040

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

1041

# +optional

1042

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

1043

# been deleted, this object will be garbage collected.

1044

# +optional

1045

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

1046

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

1047

# is no namespace field.

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

# +optional

1055

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

1056

# More info:

1057

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

1058

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

1059

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

1060

# reference is removed.

1061

# Defaults to false.

1062

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

1063

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

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

1068

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

1069

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

1070

# represented in RFC3339 form and is in UTC.

1071

#

1072

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

1077

# +optional

1078

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

1079

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

1080

# and routes.

1081

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

1086

# Populated by the system. Read-only.

1087

# +optional

1088

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

1089

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

1090

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

1091

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

1092

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

1093

# particular resource or set of resources.

1094

#

1095

# Populated by the system.

1096

# Read-only.

1097

# Value must be treated as opaque by clients and .

1098

# More info:

1099

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

1100

# +optional

1101

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

1102

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

1103

# allowed to change on PUT operations.

1104

#

1105

# Populated by the system.

1106

# Read-only.

1107

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

1108

# +optional

1109

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

1110

# Populated by the system.

1111

# Read-only.

1112

# +optional

1113

# string selfLink = 4;

1114

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

1115

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

1116

# project ID or project number.

},

}</pre>

</div>

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

1123

<pre>Rpc to list cloudpubsubsources.

1124

1125

Args:

1126

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

1127

be listed. (required)

1128

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

1129

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

1130

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

1131

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

1132

Not currently used by Cloud Run.

1133

includeUninitialized: boolean, Not currently used by Cloud Run.

1134

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

1135

start. Not currently used by Cloud Run.

1136

continue: string, Optional encoded string to continue paging.

1137

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

1138

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

1139

Not currently used by Cloud Run.

1140

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1147

1148

{ # ListCloudPubSubSourcesResponse is a list of CloudPubSubSource resources.

1149

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

1150

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

1151

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

1152

"A String",

1153

],

1154

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

1155

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

1156

# {ObjectMeta, ListMeta}.

1157

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

1158

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

1159

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

1160

# Populated by the system.

1161

# Read-only.

1162

# More info:

1163

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

1164

# +optional

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

# response.

1173

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

1174

# Populated by the system.

# Read-only.

# +optional

},

"items": [ # List of CloudPubSubSources.

1179

{

1180

"status": { # CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. # Status represents the current state of the CloudPubSubSource. This data may

1181

# be out of date. +optional

1182

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

1183

# of the CloudPubSubSource.

1184

{ # Condition defines a generic condition for a Resource

1185

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

1186

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

1187

"type": "A String", # type is used to communicate the status of the reconciliation process.

1188

# See also:

1189

# https://github.com/knative/serving/blob/master/docs/spec/errors.md#error-conditions-and-reporting

1190

# Types common to all resources include:

1191

# * "Ready": True when the Resource is ready.

1192

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

1193

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

1194

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

1195

},

1196

],

1197

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

1198

# was last processed by the controller.

1199

"sinkUri": "A String", # SinkURI is the current active sink URI that has been configured for the

# Source.

# +optional

},

"apiVersion": "A String", # The API version for this call such as "events.cloud.google.com/v1alpha1".

1204

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

1205

"retainAckedMessages": True or False, # RetainAckedMessages defines whether to retain acknowledged messages. If

1206

# true, acknowledged messages will not be expunged until they fall out of

1207

# the RetentionDuration window.

1208

"retentionDuration": "A String", # RetentionDuration defines how long to retain messages in backlog, from

1209

# the time of publish. If RetainAckedMessages is true, this duration

1210

# affects the retention of acknowledged messages, otherwise only

1211

# unacknowledged messages are retained. Cannot be longer than 7 days or

1212

# shorter than 10 minutes. Defaults to 7 days ('7d').

1213

# +optional

1214

"ackDeadline": "A String", # AckDeadline is the default maximum time after a subscriber receives a

1215

# message before the subscriber should acknowledge the message. Defaults

1216

# to 30 seconds ('30s').

1217

# +optional

1218

"ceOverrides": { # CloudEventOverrides defines arguments for a Source that control the output # CloudEventOverrides defines overrides to control the output format and

1219

# modifications of the event sent to the sink.

1220

# +optional

1221

# format of the CloudEvents produced by the Source.

1222

"extensions": { # Extensions specify what attribute are added or overridden on the outbound

1223

# event. Each `Extensions` key-value pair are set on the event as an

1224

# attribute extension independently.

# +optional

"a_key": "A String",

},

},

"secret": { # Cloud Run fully managed: not supported # Secret is the credential to use to create the Scheduler Job.

1230

# If not specified, defaults to:

1231

# Name: google-cloud-key

# Key: key.json

# +optional

#

# Cloud Run on GKE: supported

1236

#

1237

# SecretKeySelector selects a key of a Secret.

1238

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined

1239

# directly into the message. Use the "name" field instead.

1240

# referenced object inside the same namespace.

1241

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

1242

# More info:

1243

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

1244

},

1245

"optional": True or False, # Cloud Run fully managed: not supported

1246

#

1247

# Cloud Run on GKE: supported

1248

#

1249

# Specify whether the Secret or its key must be defined

1250

# +optional

1251

"key": "A String", # Cloud Run fully managed: not supported

1252

#

1253

# Cloud Run on GKE: supported

1254

#

1255

# The key of the secret to select from. Must be a valid secret key.

1256

"name": "A String", # Cloud Run fully managed: not supported

1257

#

1258

# Cloud Run on GKE: supported

1259

#

1260

# The name of the secret in the pod's namespace to select from.

1261

},

1262

"project": "A String", # Project is the ID of the Google Cloud Project that the CloudPubSubSource

1263

# Topic exists in. If omitted, defaults to same as the cluster. +optional

1264

"topic": "A String", # Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must

1265

# be in the form of the unique identifier within the project, not the

1266

# entire name. E.g. it must be 'laconia', not

1267

# 'projects/my-proj/topics/laconia'.

1268

"pubsubSecret": { # Cloud Run fully managed: not supported # CloudPubSubSourceSecret is the credential to use to create

1269

# Topic / PullSubscription resources. If omitted, uses Secret.

1270

#

1271

# Cloud Run on GKE: supported

1272

#

1273

# SecretKeySelector selects a key of a Secret.

1274

"localObjectReference": { # LocalObjectReference contains enough information to let you locate the # This field should not be used directly as it is meant to be inlined

1275

# directly into the message. Use the "name" field instead.

1276

# referenced object inside the same namespace.

1277

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

1278

# More info:

1279

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

1280

},

1281

"optional": True or False, # Cloud Run fully managed: not supported

1282

#

1283

# Cloud Run on GKE: supported

1284

#

1285

# Specify whether the Secret or its key must be defined

1286

# +optional

1287

"key": "A String", # Cloud Run fully managed: not supported

1288

#

1289

# Cloud Run on GKE: supported

1290

#

1291

# The key of the secret to select from. Must be a valid secret key.

1292

"name": "A String", # Cloud Run fully managed: not supported

1293

#

1294

# Cloud Run on GKE: supported

1295

#

1296

# The name of the secret in the pod's namespace to select from.

1297

},

1298

"sink": { # Sink is a reference to an object that will resolve to a domain name or a

1299

# URI directly to use as the sink.

1300

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

1301

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

1302

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

1303

# + optional

1304

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

1305

# + optional

1306

# referred object.

1307

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

1308

# +optional

1309

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

1310

# More info:

1311

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

1312

# +optional

1313

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

1314

# More info:

1315

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

1316

# +optional

1317

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

1318

# More info:

1319

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

1320

# +optional

1321

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

1322

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

1323

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

1324

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

1325

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

1326

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

1327

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

1328

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

1329

# object.

1330

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

1331

# More info:

1332

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

1333

# +optional

1334

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

1335

# More info:

1336

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

# +optional

},

},

},

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

1342

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

1343

# all objects users must create.

1344

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

1345

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

1346

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

1347

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

1348

"a_key": "A String",

1349

},

1350

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

1351

#

1352

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

1353

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

1354

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

1355

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

1356

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

1357

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

1358

# server.

1359

#

1360

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

1361

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

1362

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

1363

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

1364

# indicated in the Retry-After header).

1365

#

1366

# Applied only if Name is not specified.

1367

# More info:

1368

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

1369

# +optional

1370

# string generateName = 2;

1371

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

1372

# Is required when creating

1373

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

1374

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

1375

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

1376

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

1377

# +optional

1378

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

1379

#

1380

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

1381

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

1382

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

1383

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

1384

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

1385

#

1386

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

1387

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

1388

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

1389

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

1390

#

1391

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

1392

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

1393

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

1394

# in this list can only be removed.

1395

# +optional

1396

# +patchStrategy=merge

1397

"A String",

1398

],

1399

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

1400

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

1401

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

1402

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

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

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

1411

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

1412

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

1413

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

1414

# resource is fully terminated.

1415

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

1416

#

1417

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

1418

# Read-only.

1419

# More info:

1420

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

1421

# +optional

1422

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

1423

# been deleted, this object will be garbage collected.

1424

# +optional

1425

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

1426

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

1427

# is no namespace field.

1428

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

1429

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

1430

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

1431

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

1432

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

1433

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

1434

# +optional

1435

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

1436

# More info:

1437

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

1438

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

1439

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

1440

# reference is removed.

1441

# Defaults to false.

1442

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

1443

# otherwise 422 (Unprocessable Entity) will be returned.

# +optional

},

],

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

1448

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

1449

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

1450

# represented in RFC3339 form and is in UTC.

1451

#

1452

# Populated by the system.

# Read-only.

# Null for lists.

# More info:

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

1457

# +optional

1458

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

1459

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

1460

# and routes.

1461

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

1466

# Populated by the system. Read-only.

1467

# +optional

1468

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

1469

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

1470

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

1471

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

1472

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

1473

# particular resource or set of resources.

1474

#

1475

# Populated by the system.

1476

# Read-only.

1477

# Value must be treated as opaque by clients and .

1478

# More info:

1479

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

1480

# +optional

1481

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

1482

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

1483

# allowed to change on PUT operations.

1484

#

1485

# Populated by the system.

1486

# Read-only.

1487

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

1488

# +optional

1489

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

1490

# Populated by the system.

1491

# Read-only.

1492

# +optional

1493

# string selfLink = 4;

1494

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

1495

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

1496

# project ID or project number.

},

},

],

}</pre>

</div>

</body></html>