Class: Google::Apis::StorageV1::Bucket

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/storage_v1/classes.rb,
generated/google/apis/storage_v1/representations.rb,
generated/google/apis/storage_v1/representations.rb

Overview

A bucket.

Defined Under Namespace

Classes: Billing, CorsConfiguration, Encryption, Lifecycle, Logging, Owner, Versioning, Website

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Bucket

Returns a new instance of Bucket



151
152
153
 
# File 'generated/google/apis/storage_v1/classes.rb', line 151

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#acl ⇒ Array<Google::Apis::StorageV1::BucketAccessControl>

Access controls on the bucket. Corresponds to the JSON property acl

Returns:



32
33
34
 
# File 'generated/google/apis/storage_v1/classes.rb', line 32

def acl
  @acl
end

#billing ⇒ Google::Apis::StorageV1::Bucket::Billing

The bucket's billing configuration. Corresponds to the JSON property billing

Returns:



37
38
39
 
# File 'generated/google/apis/storage_v1/classes.rb', line 37

def billing
  @billing
end

#cors_configurations ⇒ Array<Google::Apis::StorageV1::Bucket::CorsConfiguration>

The bucket's Cross-Origin Resource Sharing (CORS) configuration. Corresponds to the JSON property cors

Returns:



42
43
44
 
# File 'generated/google/apis/storage_v1/classes.rb', line 42

def cors_configurations
  @cors_configurations
end

#default_object_acl ⇒ Array<Google::Apis::StorageV1::ObjectAccessControl>

Default access controls to apply to new objects when no ACL is provided. Corresponds to the JSON property defaultObjectAcl

Returns:



47
48
49
 
# File 'generated/google/apis/storage_v1/classes.rb', line 47

def default_object_acl
  @default_object_acl
end

#encryption ⇒ Google::Apis::StorageV1::Bucket::Encryption

Encryption configuration used by default for newly inserted objects, when no encryption config is specified. Corresponds to the JSON property encryption

Returns:



53
54
55
 
# File 'generated/google/apis/storage_v1/classes.rb', line 53

def encryption
  @encryption
end

#etag ⇒ String

HTTP 1.1 Entity tag for the bucket. Corresponds to the JSON property etag

Returns:

  • (String) 


58
59
60
 
# File 'generated/google/apis/storage_v1/classes.rb', line 58

def etag
  @etag
end

#id ⇒ String

The ID of the bucket. For buckets, the id and name properities are the same. Corresponds to the JSON property id

Returns:

  • (String) 


63
64
65
 
# File 'generated/google/apis/storage_v1/classes.rb', line 63

def id
  @id
end

#kind ⇒ String

The kind of item this is. For buckets, this is always storage#bucket. Corresponds to the JSON property kind

Returns:

  • (String) 


68
69
70
 
# File 'generated/google/apis/storage_v1/classes.rb', line 68

def kind
  @kind
end

#labels ⇒ Hash<String,String>

User-provided labels, in key/value pairs. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


73
74
75
 
# File 'generated/google/apis/storage_v1/classes.rb', line 73

def labels
  @labels
end

#lifecycle ⇒ Google::Apis::StorageV1::Bucket::Lifecycle

The bucket's lifecycle configuration. See lifecycle management for more information. Corresponds to the JSON property lifecycle

Returns:



79
80
81
 
# File 'generated/google/apis/storage_v1/classes.rb', line 79

def lifecycle
  @lifecycle
end

#location ⇒ String

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list. Corresponds to the JSON property location

Returns:

  • (String) 


86
87
88
 
# File 'generated/google/apis/storage_v1/classes.rb', line 86

def location
  @location
end

#logging ⇒ Google::Apis::StorageV1::Bucket::Logging

The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. Corresponds to the JSON property logging

Returns:



92
93
94
 
# File 'generated/google/apis/storage_v1/classes.rb', line 92

def logging
  @logging
end

#metageneration ⇒ Fixnum

The metadata generation of this bucket. Corresponds to the JSON property metageneration

Returns:

  • (Fixnum) 


97
98
99
 
# File 'generated/google/apis/storage_v1/classes.rb', line 97

def metageneration
  @metageneration
end

#name ⇒ String

The name of the bucket. Corresponds to the JSON property name

Returns:

  • (String) 


102
103
104
 
# File 'generated/google/apis/storage_v1/classes.rb', line 102

def name
  @name
end

#owner ⇒ Google::Apis::StorageV1::Bucket::Owner

The owner of the bucket. This is always the project team's owner group. Corresponds to the JSON property owner

Returns:



107
108
109
 
# File 'generated/google/apis/storage_v1/classes.rb', line 107

def owner
  @owner
end

#project_number ⇒ Fixnum

The project number of the project the bucket belongs to. Corresponds to the JSON property projectNumber

Returns:

  • (Fixnum) 


112
113
114
 
# File 'generated/google/apis/storage_v1/classes.rb', line 112

def project_number
  @project_number
end

#self_link ⇒ String

The URI of this bucket. Corresponds to the JSON property selfLink

Returns:

  • (String) 


117
118
119
 
# File 'generated/google/apis/storage_v1/classes.rb', line 117

def self_link
  @self_link
end

#storage_class ⇒ String

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. Corresponds to the JSON property storageClass

Returns:

  • (String) 


127
128
129
 
# File 'generated/google/apis/storage_v1/classes.rb', line 127

def storage_class
  @storage_class
end

#time_created ⇒ DateTime

The creation time of the bucket in RFC 3339 format. Corresponds to the JSON property timeCreated

Returns:

  • (DateTime) 


132
133
134
 
# File 'generated/google/apis/storage_v1/classes.rb', line 132

def time_created
  @time_created
end

#updated ⇒ DateTime

The modification time of the bucket in RFC 3339 format. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


137
138
139
 
# File 'generated/google/apis/storage_v1/classes.rb', line 137

def updated
  @updated
end

#versioning ⇒ Google::Apis::StorageV1::Bucket::Versioning

The bucket's versioning configuration. Corresponds to the JSON property versioning

Returns:



142
143
144
 
# File 'generated/google/apis/storage_v1/classes.rb', line 142

def versioning
  @versioning
end

#website ⇒ Google::Apis::StorageV1::Bucket::Website

The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. Corresponds to the JSON property website

Returns:



149
150
151
 
# File 'generated/google/apis/storage_v1/classes.rb', line 149

def website
  @website
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'generated/google/apis/storage_v1/classes.rb', line 156

def update!(**args)
  @acl = args[:acl] if args.key?(:acl)
  @billing = args[:billing] if args.key?(:billing)
  @cors_configurations = args[:cors_configurations] if args.key?(:cors_configurations)
  @default_object_acl = args[:default_object_acl] if args.key?(:default_object_acl)
  @encryption = args[:encryption] if args.key?(:encryption)
  @etag = args[:etag] if args.key?(:etag)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @lifecycle = args[:lifecycle] if args.key?(:lifecycle)
  @location = args[:location] if args.key?(:location)
  @logging = args[:logging] if args.key?(:logging)
  @metageneration = args[:metageneration] if args.key?(:metageneration)
  @name = args[:name] if args.key?(:name)
  @owner = args[:owner] if args.key?(:owner)
  @project_number = args[:project_number] if args.key?(:project_number)
  @self_link = args[:self_link] if args.key?(:self_link)
  @storage_class = args[:storage_class] if args.key?(:storage_class)
  @time_created = args[:time_created] if args.key?(:time_created)
  @updated = args[:updated] if args.key?(:updated)
  @versioning = args[:versioning] if args.key?(:versioning)
  @website = args[:website] if args.key?(:website)
end