OLD | NEW |
1 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 /// This library provides access to Google Cloud Storage. | 5 /// This library provides access to Google Cloud Storage. |
6 /// | 6 /// |
7 /// Google Cloud Storage is an object store for binary objects. Each | 7 /// Google Cloud Storage is an object store for binary objects. Each |
8 /// object has a set of metadata attached to it. For more information on | 8 /// object has a set of metadata attached to it. For more information on |
9 /// Google Cloud Sorage see https://developers.google.com/storage/. | 9 /// Google Cloud Sorage see https://developers.google.com/storage/. |
10 /// | 10 /// |
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
70 /// | 70 /// |
71 /// The returned object will be the one which was previously registered with | 71 /// The returned object will be the one which was previously registered with |
72 /// [registerStorageService] within the current (or a parent) service scope. | 72 /// [registerStorageService] within the current (or a parent) service scope. |
73 /// | 73 /// |
74 /// Accessing this getter outside of a service scope will result in an error. | 74 /// Accessing this getter outside of a service scope will result in an error. |
75 /// See the `package:gcloud/service_scope.dart` library for more information. | 75 /// See the `package:gcloud/service_scope.dart` library for more information. |
76 Storage get storageService => ss.lookup(_storageKey); | 76 Storage get storageService => ss.lookup(_storageKey); |
77 | 77 |
78 /// Registers the [storage] object within the current service scope. | 78 /// Registers the [storage] object within the current service scope. |
79 /// | 79 /// |
80 /// The provided `storage` object will be avilable via the top-level | 80 /// The provided `storage` object will be available via the top-level |
81 /// `storageService` getter. | 81 /// `storageService` getter. |
82 /// | 82 /// |
83 /// Calling this function outside of a service scope will result in an error. | 83 /// Calling this function outside of a service scope will result in an error. |
84 /// Calling this function more than once inside the same service scope is not | 84 /// Calling this function more than once inside the same service scope is not |
85 /// allowed. | 85 /// allowed. |
86 void registerStorageService(Storage storage) { | 86 void registerStorageService(Storage storage) { |
87 ss.register(_storageKey, storage); | 87 ss.register(_storageKey, storage); |
88 } | 88 } |
89 | 89 |
90 int _jenkinsHash(List e) { | 90 int _jenkinsHash(List e) { |
(...skipping 335 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
426 | 426 |
427 String toString() => 'AclPermission($_id)'; | 427 String toString() => 'AclPermission($_id)'; |
428 } | 428 } |
429 | 429 |
430 /// Definition of predefined ACLs. | 430 /// Definition of predefined ACLs. |
431 /// | 431 /// |
432 /// There is a convenient way of referring to number of _predefined_ ACLs. These | 432 /// There is a convenient way of referring to number of _predefined_ ACLs. These |
433 /// predefined ACLs have explicit names, and can _only_ be used to set an ACL, | 433 /// predefined ACLs have explicit names, and can _only_ be used to set an ACL, |
434 /// when either creating or updating a bucket or object. This set of predefined | 434 /// when either creating or updating a bucket or object. This set of predefined |
435 /// ACLs are expanded on the server to their actual list of [AclEntry] objects. | 435 /// ACLs are expanded on the server to their actual list of [AclEntry] objects. |
436 /// When information is retreived on a bucket or object, this expanded list will | 436 /// When information is retrieved on a bucket or object, this expanded list will |
437 /// be present. For a description of these predefined ACLs see: | 437 /// be present. For a description of these predefined ACLs see: |
438 /// https://cloud.google.com/storage/docs/accesscontrol#extension. | 438 /// https://cloud.google.com/storage/docs/accesscontrol#extension. |
439 class PredefinedAcl { | 439 class PredefinedAcl { |
440 final String _name; | 440 final String _name; |
441 const PredefinedAcl._(this._name); | 441 const PredefinedAcl._(this._name); |
442 | 442 |
443 /// Predefined ACL for the 'authenticated-read' ACL. Applies to both buckets | 443 /// Predefined ACL for the 'authenticated-read' ACL. Applies to both buckets |
444 /// and objects. | 444 /// and objects. |
445 static const PredefinedAcl authenticatedRead = | 445 static const PredefinedAcl authenticatedRead = |
446 const PredefinedAcl._('authenticatedRead'); | 446 const PredefinedAcl._('authenticatedRead'); |
(...skipping 325 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
772 /// Start paging through objects in the bucket. | 772 /// Start paging through objects in the bucket. |
773 /// | 773 /// |
774 /// The maximum number of objects in each page is specified in [pageSize]. | 774 /// The maximum number of objects in each page is specified in [pageSize]. |
775 /// | 775 /// |
776 /// See [list] for more information on the other arguments. | 776 /// See [list] for more information on the other arguments. |
777 /// | 777 /// |
778 /// Returns a `Future` which completes with a `Page` object holding the | 778 /// Returns a `Future` which completes with a `Page` object holding the |
779 /// first page. Use the `Page` object to move to the next page. | 779 /// first page. Use the `Page` object to move to the next page. |
780 Future<Page<BucketEntry>> page({String prefix, int pageSize: 50}); | 780 Future<Page<BucketEntry>> page({String prefix, int pageSize: 50}); |
781 } | 781 } |
OLD | NEW |