google-cloud-python/0.10.1/gcloud-api.html at gh-pages · codevulture/google-cloud-python

History

1126 lines (1041 loc) · 88.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<head>

<title>Shared Core Modules — gcloud 0.10.1 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: './',

VERSION: '0.10.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

</head>

gcloud

</a>

</h1>

<div class="nav-current">Python</div>

<li>

<a href="

https://googlecloudplatform.github.io/gcloud-java/" title="gcloud-java page">

Java

</a>

</li>

<li>

<a href="

https://googlecloudplatform.github.io/gcloud-node/#/docs" title="Node.js docs page">

Node.js

</a>

</li>

<li>

Python

</a>

</li>

<li>

<a href="

http://googlecloudplatform.github.io/gcloud-ruby/docs/latest" title="Ruby docs page">

Ruby

</a>

</li>

</ul>

</nav>

Report an Issue

</a>

</header>

Version History (0.10.1)

</a>

</div>

<div>

Report an Issue

</a>

</div>

</header>

<h1>Shared Core Modules<a class="headerlink" href="#shared-core-modules" title="Permalink to this headline">#</a></h1>

<h2>Base Client<a class="headerlink" href="#module-gcloud.client" title="Permalink to this headline">#</a></h2>

Base classes for client used to interact with Google Cloud APIs.

class <code class="descclassname">gcloud.client.</code><code class="descname">Client</code>(credentials=None, http=None)<a class="reference internal" href="_modules/gcloud/client.html#Client">[source]</a><a class="headerlink" href="#gcloud.client.Client" title="Permalink to this definition">#</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal">gcloud.client._ClientFactoryMixin</code>

Client to bundle configuration needed for API requests.

Assumes that the associated <code class="docutils literal">_connection_class</code> only accepts

<code class="docutils literal">http</code> and <code class="docutils literal">credentials</code> in its constructor.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

<li>credentials (<a class="reference external" href="http://oauth2client.readthedocs.org/en/latest/source/oauth2client.client.html#oauth2client.client.OAuth2Credentials" title="(in oauth2client v2.0.0.post1)"><code class="xref py py-class docutils literal">oauth2client.client.OAuth2Credentials</code></a> or

<code class="xref py py-class docutils literal">NoneType</code>) – The OAuth2 Credentials to use for the connection

owned by this client. If not passed (and if no <code class="docutils literal">http</code>

object is passed), falls back to the default inferred

from the environment.</li>

<li>http (<a class="reference external" href="http://bitworking.org/projects/httplib2/doc/html/libhttplib2.html#httplib2.Http" title="(in httplib2 v0.4)"><code class="xref py py-class docutils literal">httplib2.Http</code></a> or class that defines <code class="docutils literal">request()</code>.) – An optional HTTP object to make requests. If not passed, an

<code class="docutils literal">http</code> object is created that is bound to the

<code class="docutils literal">credentials</code> for the current object.</li>

</ul>

</td>

</tr>

</tbody>

</table>

<code class="descname">from_service_account_json</code>(json_credentials_path, *args, **kwargs)<a class="headerlink" href="#gcloud.client.Client.from_service_account_json" title="Permalink to this definition">#</a></dt>

<dd>Factory to retrieve JSON credentials while creating client.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

<li>json_credentials_path (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The path to a private key file (this file

was given to you when you created the

service account). This file must contain

a JSON object with a private key and

other credentials information (downloaded

from the Google APIs console).</li>

<li>args (<a class="reference external" href="https://docs.python.org/library/functions.html#tuple" title="(in Python v2.7)">tuple</a>) – Remaining positional arguments to pass to constructor.</li>

<li>kwargs (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)">dict</a>) – Remaining keyword arguments to pass to constructor.</li>

</ul>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="pubsub-client.html#gcloud.pubsub.client.Client" title="gcloud.pubsub.client.Client"><code class="xref py py-class docutils literal">gcloud.pubsub.client.Client</code></a>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The client created with the retrieved JSON credentials.

</td>

</tr>

<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal">TypeError</code> if there is a conflict with the kwargs

and the credentials created by the factory.

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">from_service_account_p12</code>(client_email, private_key_path, *args, **kwargs)<a class="headerlink" href="#gcloud.client.Client.from_service_account_p12" title="Permalink to this definition">#</a></dt>

<dd>Factory to retrieve P12 credentials while creating client.

Note

Unless you have an explicit reason to use a PKCS12 key for your

service account, we recommend using a JSON key.

</div>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

<li>client_email (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The e-mail attached to the service account.</li>

<li>private_key_path (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The path to a private key file (this file was

given to you when you created the service

account). This file must be in P12 format.</li>

</ul>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#gcloud.client.Client" title="gcloud.client.Client"><code class="xref py py-class docutils literal">gcloud.client.Client</code></a>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The client created with the retrieved P12 credentials.

</td>

</tr>

and the credentials created by the factory.

</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">gcloud.client.</code><code class="descname">JSONClient</code>(project=None, credentials=None, http=None)<a class="reference internal" href="_modules/gcloud/client.html#JSONClient">[source]</a><a class="headerlink" href="#gcloud.client.JSONClient" title="Permalink to this definition">#</a></dt>

<dd>Bases: <a class="reference internal" href="#gcloud.client.Client" title="gcloud.client.Client"><code class="xref py py-class docutils literal">gcloud.client.Client</code></a>, <code class="xref py py-class docutils literal">gcloud.client._ClientProjectMixin</code>

Client to for Google JSON-based API.

Assumes such APIs use the <code class="docutils literal">project</code> and the client needs to store this

value.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

<li>project (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – the project which the client acts on behalf of. If not

passed falls back to the default inferred from the

environment.</li>

<code class="xref py py-class docutils literal">NoneType</code>) – The OAuth2 Credentials to use for the connection

owned by this client. If not passed (and if no <code class="docutils literal">http</code>

object is passed), falls back to the default inferred

from the environment.</li>

<code class="docutils literal">http</code> object is created that is bound to the

<code class="docutils literal">credentials</code> for the current object.</li>

</ul>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-class docutils literal">ValueError</code> if the project is neither passed in nor

set in the environment.

</td>

</tr>

</tbody>

</table>

<code class="descname">from_service_account_json</code>(json_credentials_path, *args, **kwargs)<a class="headerlink" href="#gcloud.client.JSONClient.from_service_account_json" title="Permalink to this definition">#</a></dt>

<dd>Factory to retrieve JSON credentials while creating client.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

was given to you when you created the

service account). This file must contain

a JSON object with a private key and

other credentials information (downloaded

from the Google APIs console).</li>

</ul>

</td>

</tr>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The client created with the retrieved JSON credentials.

</td>

</tr>

and the credentials created by the factory.

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">from_service_account_p12</code>(client_email, private_key_path, *args, **kwargs)<a class="headerlink" href="#gcloud.client.JSONClient.from_service_account_p12" title="Permalink to this definition">#</a></dt>

<dd>Factory to retrieve P12 credentials while creating client.

Note

Unless you have an explicit reason to use a PKCS12 key for your

service account, we recommend using a JSON key.

</div>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

given to you when you created the service

account). This file must be in P12 format.</li>

</ul>

</td>

</tr>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The client created with the retrieved P12 credentials.

</td>

</tr>

and the credentials created by the factory.

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

<h2>Credentials Helpers<a class="headerlink" href="#module-gcloud.credentials" title="Permalink to this headline">#</a></h2>

A simple wrapper around the OAuth2 credentials library.

<code class="descclassname">gcloud.credentials.</code><code class="descname">generate_signed_url</code>(credentials, resource, expiration, api_access_endpoint='', method='GET', content_md5=None, content_type=None, response_type=None, response_disposition=None, generation=None)<a class="reference internal" href="_modules/gcloud/credentials.html#generate_signed_url">[source]</a><a class="headerlink" href="#gcloud.credentials.generate_signed_url" title="Permalink to this definition">#</a></dt>

<dd>Generate signed URL to provide query-string auth’n to a resource.

Note

If you are on Google Compute Engine, you can’t generate a signed URL.

Follow <a class="reference external" href="https://github.com/GoogleCloudPlatform/gcloud-python/issues/922">Issue 922</a> for updates on this. If you’d like to be able to

generate a signed URL from GCE, you can use a standard service account

from a JSON file rather than a GCE service account.

</div>

See headers <a class="reference external" href="https://cloud.google.com/storage/docs/reference-headers">reference</a> for more details on optional arguments.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

<li>credentials (<code class="xref py py-class docutils literal">oauth2client.appengine.AppAssertionCredentials</code>) – Credentials object with an associated private key to

sign text.</li>

<li>resource (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – A pointer to a specific resource

(typically, <code class="docutils literal">/bucket-name/path/to/blob.txt</code>).</li>

<li>expiration (<a class="reference external" href="https://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><code class="xref py py-class docutils literal">int</code></a>, <a class="reference external" href="https://docs.python.org/library/functions.html#long" title="(in Python v2.7)"><code class="xref py py-class docutils literal">long</code></a>, <a class="reference external" href="https://docs.python.org/library/datetime.html#datetime.datetime" title="(in Python v2.7)"><code class="xref py py-class docutils literal">datetime.datetime</code></a>,

<a class="reference external" href="https://docs.python.org/library/datetime.html#datetime.timedelta" title="(in Python v2.7)"><code class="xref py py-class docutils literal">datetime.timedelta</code></a>) – When the signed URL should expire.</li>

<li>api_access_endpoint (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a>) – Optional URI base. Defaults to empty string.</li>

<li>method (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a>) – The HTTP verb that will be used when requesting the URL.

Defaults to <code class="docutils literal">'GET'</code>.</li>

<li>content_md5 (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a>) – (Optional) The MD5 hash of the object referenced by

<code class="docutils literal">resource</code>.</li>

<li>content_type (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a>) – (Optional) The content type of the object referenced

by <code class="docutils literal">resource</code>.</li>

<li>response_type (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a>) – (Optional) Content type of responses to requests for

the signed URL. Used to over-ride the content type of

the underlying resource.</li>

<li>response_disposition (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a>) – (Optional) Content disposition of responses to

requests for the signed URL.</li>

<li>generation (<a class="reference external" href="https://docs.python.org/library/functions.html#str" title="(in Python v2.7)">str</a>) – (Optional) A value that indicates which generation of

the resource to fetch.</li>

</ul>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A signed URL you can use to access the resource

until expiration.

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">gcloud.credentials.</code><code class="descname">get_credentials</code>()<a class="reference internal" href="_modules/gcloud/credentials.html#get_credentials">[source]</a><a class="headerlink" href="#gcloud.credentials.get_credentials" title="Permalink to this definition">#</a></dt>

<dd>Gets credentials implicitly from the current environment.

Note

You should not need to use this function directly. Instead, use a

helper method which uses this method under the hood.

</div>

Checks environment in order of precedence:

<li>Google App Engine (production and testing)</li>

<li>Environment variable <code class="xref std std-envvar docutils literal">GOOGLE_APPLICATION_CREDENTIALS</code> pointing to

a file with stored credentials information.</li>

<li>Stored “well known” file associated with <code class="docutils literal">gcloud</code> command line tool.</li>

<li>Google Compute Engine production environment.</li>

</ul>

The file referred to in <code class="xref std std-envvar docutils literal">GOOGLE_APPLICATION_CREDENTIALS</code> is

expected to contain information about credentials that are ready to use.

This means either service account information or user account information

with a ready-to-use refresh token:

<div class="code json highlight-python"><div class="highlight"><pre>{

'type': 'authorized_user',

'client_id': '...',

'client_secret': '...',

'refresh_token': '...'

}

</pre></div>

</div>

or

<div class="code json highlight-python"><div class="highlight"><pre>{

'type': 'service_account',

'client_id': '...',

'client_email': '...',

'private_key_id': '...',

'private_key': '...'

}

</pre></div>

</div>

The second of these is simply a JSON key downloaded from the Google APIs

console. The first is a close cousin of the “client secrets” JSON file

used by <a class="reference external" href="http://oauth2client.readthedocs.org/en/latest/source/oauth2client.clientsecrets.html#module-oauth2client.clientsecrets" title="(in oauth2client v2.0.0.post1)"><code class="xref py py-mod docutils literal">oauth2client.clientsecrets</code></a> but differs in formatting.

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="http://oauth2client.readthedocs.org/en/latest/source/oauth2client.client.html#oauth2client.client.GoogleCredentials" title="(in oauth2client v2.0.0.post1)"><code class="xref py py-class docutils literal">oauth2client.client.GoogleCredentials</code></a>,

<code class="xref py py-class docutils literal">oauth2client.contrib.appengine.AppAssertionCredentials</code>,

<a class="reference external" href="http://oauth2client.readthedocs.org/en/latest/source/oauth2client.contrib.gce.html#oauth2client.contrib.gce.AppAssertionCredentials" title="(in oauth2client v2.0.0.post1)"><code class="xref py py-class docutils literal">oauth2client.contrib.gce.AppAssertionCredentials</code></a>,

<a class="reference external" href="http://oauth2client.readthedocs.org/en/latest/source/oauth2client.service_account.html#oauth2client.service_account.ServiceAccountCredentials" title="(in oauth2client v2.0.0.post1)"><code class="xref py py-class docutils literal">oauth2client.service_account.ServiceAccountCredentials</code></a></td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A new credentials instance corresponding to the implicit

environment.</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">gcloud.credentials.</code><code class="descname">get_for_service_account_json</code>(json_credentials_path, scope=None)<a class="reference internal" href="_modules/gcloud/credentials.html#get_for_service_account_json">[source]</a><a class="headerlink" href="#gcloud.credentials.get_for_service_account_json" title="Permalink to this definition">#</a></dt>

<dd>Gets the credentials for a service account with JSON key.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

given to you when you created the service

account). This file must contain a JSON

object with a private key and other

credentials information (downloaded from the

Google APIs console).</li>

<li>scope (string or tuple of string) – The scope against which to authenticate. (Different services

require different scopes, check the documentation for which

scope is required for the different levels of access to any

particular API.)</li>

</ul>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="http://oauth2client.readthedocs.org/en/latest/source/oauth2client.client.html#oauth2client.client.GoogleCredentials" title="(in oauth2client v2.0.0.post1)"><code class="xref py py-class docutils literal">oauth2client.client.GoogleCredentials</code></a>,

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">New service account or Google (for a user JSON key file)

credentials object.

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">gcloud.credentials.</code><code class="descname">get_for_service_account_p12</code>(client_email, private_key_path, scope=None)<a class="reference internal" href="_modules/gcloud/credentials.html#get_for_service_account_p12">[source]</a><a class="headerlink" href="#gcloud.credentials.get_for_service_account_p12" title="Permalink to this definition">#</a></dt>

<dd>Gets the credentials for a service account with PKCS12 / p12 key.

Note

This method is not used by default, instead <a class="reference internal" href="#gcloud.credentials.get_credentials" title="gcloud.credentials.get_credentials"><code class="xref py py-func docutils literal">get_credentials()</code></a>

is used. This method is intended to be used when the environment is

known explicitly and detecting the environment implicitly would be

superfluous.

</div>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

given to you when you created the service

account). This file must be in P12 format.</li>

<li>scope (string or tuple of string) – The scope against which to authenticate. (Different services

require different scopes, check the documentation for which

scope is required for the different levels of access to any

particular API.)</li>

</ul>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="http://oauth2client.readthedocs.org/en/latest/source/oauth2client.service_account.html#oauth2client.service_account.ServiceAccountCredentials" title="(in oauth2client v2.0.0.post1)"><code class="xref py py-class docutils literal">oauth2client.service_account.ServiceAccountCredentials</code></a>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A new <code class="docutils literal">ServiceAccountCredentials</code> instance with the

needed service account settings.

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

<h2>Base Connections<a class="headerlink" href="#module-gcloud.connection" title="Permalink to this headline">#</a></h2>

Shared implementation of connections to API servers.

<code class="descclassname">gcloud.connection.</code><code class="descname">API_BASE_URL</code> = 'https://www.googleapis.com'<a class="headerlink" href="#gcloud.connection.API_BASE_URL" title="Permalink to this definition">#</a></dt>

<dd>The base of the API call URL.

</dd></dl>

class <code class="descclassname">gcloud.connection.</code><code class="descname">Connection</code>(credentials=None, http=None)<a class="reference internal" href="_modules/gcloud/connection.html#Connection">[source]</a><a class="headerlink" href="#gcloud.connection.Connection" title="Permalink to this definition">#</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal">object</code></a>

A generic connection to Google Cloud Platform.

Subclasses should understand only the basic types in method arguments,

however they should be capable of returning advanced types.

If no value is passed in for <code class="docutils literal">http</code>, a <a class="reference external" href="http://bitworking.org/projects/httplib2/doc/html/libhttplib2.html#httplib2.Http" title="(in httplib2 v0.4)"><code class="xref py py-class docutils literal">httplib2.Http</code></a> object

will be created and authorized with the <code class="docutils literal">credentials</code>. If not, the

<code class="docutils literal">credentials</code> and <code class="docutils literal">http</code> need not be related.

Subclasses may seek to use the private key from <code class="docutils literal">credentials</code> to sign

data.

A custom (non-<code class="docutils literal">httplib2</code>) HTTP object must have a <code class="docutils literal">request</code> method

which accepts the following arguments:

<li><code class="docutils literal">method</code></li>

<li><code class="docutils literal">headers</code></li>

</ul>

In addition, <code class="docutils literal">redirections</code> and <code class="docutils literal">connection_type</code> may be used.

Without the use of <code class="docutils literal">credentials.authorize(http)</code>, a custom <code class="docutils literal">http</code>

object will also need to be able to add a bearer token to API

requests and handle token refresh on 401 errors.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

<code class="xref py py-class docutils literal">NoneType</code>) – The OAuth2 Credentials to use for this connection.</li>

</ul>

</td>

</tr>

</tbody>

</table>

<code class="descname">SCOPE</code> = None<a class="headerlink" href="#gcloud.connection.Connection.SCOPE" title="Permalink to this definition">#</a></dt>

<dd>The scopes required for authenticating with a service.

Needs to be set by subclasses.

</dd></dl>

<code class="descname">USER_AGENT</code> = 'gcloud-python/0.10.1'<a class="headerlink" href="#gcloud.connection.Connection.USER_AGENT" title="Permalink to this definition">#</a></dt>

<dd>The user agent for gcloud-python requests.

</dd></dl>

<code class="descname">credentials</code><a class="headerlink" href="#gcloud.connection.Connection.credentials" title="Permalink to this definition">#</a></dt>

<dd>Getter for current credentials.

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="http://oauth2client.readthedocs.org/en/latest/source/oauth2client.client.html#oauth2client.client.OAuth2Credentials" title="(in oauth2client v2.0.0.post1)"><code class="xref py py-class docutils literal">oauth2client.client.OAuth2Credentials</code></a> or

<code class="xref py py-class docutils literal">NoneType</code></td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The credentials object associated with this connection.</td>

</tr>

</tbody>

</table>

</dd></dl>

<dd>A getter for the HTTP transport used in talking to the API.

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="http://bitworking.org/projects/httplib2/doc/html/libhttplib2.html#httplib2.Http" title="(in httplib2 v0.4)"><code class="xref py py-class docutils literal">httplib2.Http</code></a></td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Http object used to transport data.</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">gcloud.connection.</code><code class="descname">JSONConnection</code>(credentials=None, http=None)<a class="reference internal" href="_modules/gcloud/connection.html#JSONConnection">[source]</a><a class="headerlink" href="#gcloud.connection.JSONConnection" title="Permalink to this definition">#</a></dt>

<dd>Bases: <a class="reference internal" href="#gcloud.connection.Connection" title="gcloud.connection.Connection"><code class="xref py py-class docutils literal">gcloud.connection.Connection</code></a>

A connection to a Google JSON-based API.

These APIs are discovery based. For reference:

<div><a class="reference external" href="https://developers.google.com/discovery/">https://developers.google.com/discovery/</a></div></blockquote>

This defines <a class="reference internal" href="#gcloud.connection.JSONConnection.api_request" title="gcloud.connection.JSONConnection.api_request"><code class="xref py py-meth docutils literal">api_request()</code></a> for making a generic JSON

API request and API requests are created elsewhere.

The class constants

<li><a class="reference internal" href="#gcloud.connection.JSONConnection.API_VERSION" title="gcloud.connection.JSONConnection.API_VERSION"><code class="xref py py-attr docutils literal">API_VERSION</code></a></li>

<li><a class="reference internal" href="#gcloud.connection.JSONConnection.API_URL_TEMPLATE" title="gcloud.connection.JSONConnection.API_URL_TEMPLATE"><code class="xref py py-attr docutils literal">API_URL_TEMPLATE</code></a></li>

</ul>

must be updated by subclasses.

<dd>The base of the API call URL.

</dd></dl>

<code class="descname">API_URL_TEMPLATE</code> = None<a class="headerlink" href="#gcloud.connection.JSONConnection.API_URL_TEMPLATE" title="Permalink to this definition">#</a></dt>

<dd>A template for the URL of a particular API call.

</dd></dl>

<code class="descname">API_VERSION</code> = None<a class="headerlink" href="#gcloud.connection.JSONConnection.API_VERSION" title="Permalink to this definition">#</a></dt>

<dd>The version of the API, used in building the API call’s URL.

</dd></dl>

<code class="descname">api_request</code>(method, path, query_params=None, data=None, content_type=None, api_base_url=None, api_version=None, expect_json=True, _target_object=None)<a class="reference internal" href="_modules/gcloud/connection.html#JSONConnection.api_request">[source]</a><a class="headerlink" href="#gcloud.connection.JSONConnection.api_request" title="Permalink to this definition">#</a></dt>

<dd>Make a request over the HTTP transport to the API.

You shouldn’t need to use this method, but if you plan to

interact with the API using these primitives, this is the

correct one to use.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

<li>method (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The HTTP method name (ie, <code class="docutils literal">GET</code>, <code class="docutils literal">POST</code>, etc).

Required.</li>

<li>path (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The path to the resource (ie, <code class="docutils literal">'/b/bucket-name'</code>).

Required.</li>

<li>query_params (<a class="reference external" href="https://docs.python.org/library/stdtypes.html#dict" title="(in Python v2.7)">dict</a>) – A dictionary of keys and values to insert into

the query string of the URL. Default is

empty dict.</li>

<li>data (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The data to send as the body of the request. Default is

the empty string.</li>

<li>content_type (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The proper MIME type of the data provided. Default

is None.</li>

<li>api_base_url (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The base URL for the API endpoint.

Typically you won’t have to provide this.

Default is the standard API base URL.</li>

<li>api_version (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – The version of the API to call. Typically

you shouldn’t provide this and instead use

the default for the library. Default is the

latest API version supported by

gcloud-python.</li>

<li>expect_json (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a>) – If True, this method will try to parse the

response as JSON and raise an exception if

that cannot be done. Default is True.</li>

<li>_target_object (<a class="reference external" href="https://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal">object</code></a> or <code class="xref py py-class docutils literal">NoneType</code>) – Protected argument to be used by library

callers. This can allow custom behavior, for

example, to defer an HTTP request and complete

initialization of the object at a later time.</li>

</ul>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">Exception if the response code is not 200 OK.

</td>

</tr>

</tbody>

</table>

</dd></dl>

classmethod <code class="descname">build_api_url</code>(path, query_params=None, api_base_url=None, api_version=None)<a class="reference internal" href="_modules/gcloud/connection.html#JSONConnection.build_api_url">[source]</a><a class="headerlink" href="#gcloud.connection.JSONConnection.build_api_url" title="Permalink to this definition">#</a></dt>

<dd>Construct an API url given a few components, some optional.

Typically, you shouldn’t need to use this method.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

the query string of the URL.</li>

Typically you won’t have to provide this.</li>

Typically you shouldn’t provide this and instead

use the default for the library.</li>

</ul>

</td>

</tr>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The URL assembled from the pieces provided.

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

<h2>Exceptions<a class="headerlink" href="#module-gcloud.exceptions" title="Permalink to this headline">#</a></h2>

Custom exceptions for <code class="xref py py-mod docutils literal">gcloud</code> package.

See: <a class="reference external" href="https://cloud.google.com/storage/docs/json_api/v1/status-codes">https://cloud.google.com/storage/docs/json_api/v1/status-codes</a>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">BadRequest</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#BadRequest">[source]</a><a class="headerlink" href="#gcloud.exceptions.BadRequest" title="Permalink to this definition">#</a></dt>

<dd>Bases: <a class="reference internal" href="#gcloud.exceptions.ClientError" title="gcloud.exceptions.ClientError"><code class="xref py py-class docutils literal">gcloud.exceptions.ClientError</code></a>

Exception mapping a ‘400 Bad Request’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">ClientError</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#ClientError">[source]</a><a class="headerlink" href="#gcloud.exceptions.ClientError" title="Permalink to this definition">#</a></dt>

<dd>Bases: <a class="reference internal" href="#gcloud.exceptions.GCloudError" title="gcloud.exceptions.GCloudError"><code class="xref py py-class docutils literal">gcloud.exceptions.GCloudError</code></a>

Base for 4xx responses

This class is abstract

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">Conflict</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#Conflict">[source]</a><a class="headerlink" href="#gcloud.exceptions.Conflict" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘409 Conflict’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">Forbidden</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#Forbidden">[source]</a><a class="headerlink" href="#gcloud.exceptions.Forbidden" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘403 Forbidden’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">GCloudError</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#GCloudError">[source]</a><a class="headerlink" href="#gcloud.exceptions.GCloudError" title="Permalink to this definition">#</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/library/exceptions.html#exceptions.Exception" title="(in Python v2.7)"><code class="xref py py-class docutils literal">exceptions.Exception</code></a>

Base error class for gcloud errors (abstract).

Each subclass represents a single type of HTTP error response.

<dd>HTTP status code. Concrete subclasses must define.

See: <a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html</a>

</dd></dl>

<code class="descname">errors</code><a class="headerlink" href="#gcloud.exceptions.GCloudError.errors" title="Permalink to this definition">#</a></dt>

<dd>Detailed error information.

<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list(dict)</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a list of mappings describing each error.</td>

</tr>

</tbody>

</table>

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">InternalServerError</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#InternalServerError">[source]</a><a class="headerlink" href="#gcloud.exceptions.InternalServerError" title="Permalink to this definition">#</a></dt>

<dd>Bases: <a class="reference internal" href="#gcloud.exceptions.ServerError" title="gcloud.exceptions.ServerError"><code class="xref py py-class docutils literal">gcloud.exceptions.ServerError</code></a>

Exception mapping a ‘500 Internal Server Error’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">LengthRequired</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#LengthRequired">[source]</a><a class="headerlink" href="#gcloud.exceptions.LengthRequired" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘411 Length Required’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">MethodNotAllowed</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#MethodNotAllowed">[source]</a><a class="headerlink" href="#gcloud.exceptions.MethodNotAllowed" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘405 Method Not Allowed’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">MovedPermanently</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#MovedPermanently">[source]</a><a class="headerlink" href="#gcloud.exceptions.MovedPermanently" title="Permalink to this definition">#</a></dt>

<dd>Bases: <a class="reference internal" href="#gcloud.exceptions.Redirection" title="gcloud.exceptions.Redirection"><code class="xref py py-class docutils literal">gcloud.exceptions.Redirection</code></a>

Exception mapping a ‘301 Moved Permanently’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">NotFound</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#NotFound">[source]</a><a class="headerlink" href="#gcloud.exceptions.NotFound" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘404 Not Found’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">NotImplemented</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#NotImplemented">[source]</a><a class="headerlink" href="#gcloud.exceptions.NotImplemented" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘501 Not Implemented’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">NotModified</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#NotModified">[source]</a><a class="headerlink" href="#gcloud.exceptions.NotModified" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘304 Not Modified’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">PreconditionFailed</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#PreconditionFailed">[source]</a><a class="headerlink" href="#gcloud.exceptions.PreconditionFailed" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘412 Precondition Failed’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">Redirection</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#Redirection">[source]</a><a class="headerlink" href="#gcloud.exceptions.Redirection" title="Permalink to this definition">#</a></dt>

Base for 3xx responses

This class is abstract.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">RequestRangeNotSatisfiable</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#RequestRangeNotSatisfiable">[source]</a><a class="headerlink" href="#gcloud.exceptions.RequestRangeNotSatisfiable" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘416 Request Range Not Satisfiable’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">ResumeIncomplete</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#ResumeIncomplete">[source]</a><a class="headerlink" href="#gcloud.exceptions.ResumeIncomplete" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘308 Resume Incomplete’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">ServerError</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#ServerError">[source]</a><a class="headerlink" href="#gcloud.exceptions.ServerError" title="Permalink to this definition">#</a></dt>

Base for 5xx responses: (abstract)

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">ServiceUnavailable</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#ServiceUnavailable">[source]</a><a class="headerlink" href="#gcloud.exceptions.ServiceUnavailable" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘503 Service Unavailable’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">TemporaryRedirect</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#TemporaryRedirect">[source]</a><a class="headerlink" href="#gcloud.exceptions.TemporaryRedirect" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘307 Temporary Redirect’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">TooManyRequests</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#TooManyRequests">[source]</a><a class="headerlink" href="#gcloud.exceptions.TooManyRequests" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘429 Too Many Requests’ response.

</dd></dl>

exception <code class="descclassname">gcloud.exceptions.</code><code class="descname">Unauthorized</code>(message, errors=())<a class="reference internal" href="_modules/gcloud/exceptions.html#Unauthorized">[source]</a><a class="headerlink" href="#gcloud.exceptions.Unauthorized" title="Permalink to this definition">#</a></dt>

Exception mapping a ‘401 Unauthorized’ response.

</dd></dl>

<code class="descclassname">gcloud.exceptions.</code><code class="descname">make_exception</code>(response, content, error_info=None, use_json=True)<a class="reference internal" href="_modules/gcloud/exceptions.html#make_exception">[source]</a><a class="headerlink" href="#gcloud.exceptions.make_exception" title="Permalink to this definition">#</a></dt>

<dd>Factory: create exception based on HTTP response code.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

<li>response (<a class="reference external" href="http://bitworking.org/projects/httplib2/doc/html/libhttplib2.html#httplib2.Response" title="(in httplib2 v0.4)"><code class="xref py py-class docutils literal">httplib2.Response</code></a> or other HTTP response object) – A response object that defines a status code as the

status attribute.</li>

<li>content (string or dictionary) – The body of the HTTP error response.</li>

<li>error_info (<a class="reference external" href="https://docs.python.org/library/string.html#module-string" title="(in Python v2.7)">string</a>) – Optional string giving extra information about the

failed request.</li>

<li>use_json (<a class="reference external" href="https://docs.python.org/library/functions.html#bool" title="(in Python v2.7)">bool</a>) – Flag indicating if <code class="docutils literal">content</code> is expected to be JSON.</li>

</ul>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">instance of <a class="reference internal" href="#gcloud.exceptions.GCloudError" title="gcloud.exceptions.GCloudError"><code class="xref py py-class docutils literal">GCloudError</code></a>, or a concrete subclass.

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Exception specific to the error response.

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

<h2>Environment Variables<a class="headerlink" href="#module-gcloud.environment_vars" title="Permalink to this headline">#</a></h2>

Comprehensive list of environment variables used in gcloud.

These enable many types of implicit behavior in both production

and tests.

<code class="descclassname">gcloud.environment_vars.</code><code class="descname">CREDENTIALS</code> = 'GOOGLE_APPLICATION_CREDENTIALS'<a class="headerlink" href="#gcloud.environment_vars.CREDENTIALS" title="Permalink to this definition">#</a></dt>

<dd>Environment variable defining location of Google credentials.

</dd></dl>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

gcloud-api.html

Latest commit

History

gcloud-api.html

File metadata and controls