Class: Google::Apis::FirebasehostingV1beta1::Channel

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

Overview

A Channel represents a stream of releases for a site. All sites have a default live channel that serves content to the Firebase-provided subdomains and any connected custom domains.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Channel

Returns a new instance of Channel.



263
264
265
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 263

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time at which the channel was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


210
211
212
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 210

def create_time
  @create_time
end

#expire_time ⇒ String

The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the ttl field. Corresponds to the JSON property expireTime

Returns:

  • (String) 


217
218
219
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 217

def expire_time
  @expire_time
end

#labels ⇒ Hash<String,String>

Text labels used for extra metadata and/or filtering. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


222
223
224
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 222

def labels
  @labels
end

#name ⇒ String

The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID Corresponds to the JSON property name

Returns:

  • (String) 


228
229
230
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 228

def name
  @name
end

#release ⇒ Google::Apis::FirebasehostingV1beta1::Release

A Release is a particular collection of configurations and files that is set to be public at a particular time. Corresponds to the JSON property release

Returns:



234
235
236
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 234

def release
  @release
end

#retained_release_count ⇒ Fixnum

The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels. Corresponds to the JSON property retainedReleaseCount

Returns:

  • (Fixnum) 


240
241
242
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 240

def retained_release_count
  @retained_release_count
end

#ttl ⇒ String

Input only. A time-to-live for this channel. Sets expire_time to the provided duration past the time of the request. Corresponds to the JSON property ttl

Returns:

  • (String) 


246
247
248
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 246

def ttl
  @ttl
end

#update_time ⇒ String

Output only. The time at which the channel was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


251
252
253
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 251

def update_time
  @update_time
end

#url ⇒ String

Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of web.app. The content of this channel's current release can also be viewed at the Firebase- provided subdomain of firebaseapp.com. If this channel is the live channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains. Corresponds to the JSON property url

Returns:

  • (String) 


261
262
263
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 261

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/google/apis/firebasehosting_v1beta1/classes.rb', line 268

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @release = args[:release] if args.key?(:release)
  @retained_release_count = args[:retained_release_count] if args.key?(:retained_release_count)
  @ttl = args[:ttl] if args.key?(:ttl)
  @update_time = args[:update_time] if args.key?(:update_time)
  @url = args[:url] if args.key?(:url)
end