Class: Google::Apis::CloudfunctionsV1::CloudFunction

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

Overview

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CloudFunction

Returns a new instance of CloudFunction



172
173
174
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 172

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

Instance Attribute Details

#available_memory_mb ⇒ Fixnum

The amount of memory in MB available for a function. Defaults to 256MB. Corresponds to the JSON property availableMemoryMb

Returns:

  • (Fixnum) 


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

def available_memory_mb
  @available_memory_mb
end

#description ⇒ String

User-provided description of a function. Corresponds to the JSON property description

Returns:

  • (String) 


91
92
93
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 91

def description
  @description
end

#entry_point ⇒ String

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source_location. Corresponds to the JSON property entryPoint

Returns:

  • (String) 


101
102
103
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 101

def entry_point
  @entry_point
end

#event_trigger ⇒ Google::Apis::CloudfunctionsV1::EventTrigger

Describes EventTrigger, used to request events be sent from another service. Corresponds to the JSON property eventTrigger

Returns:



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

def event_trigger
  @event_trigger
end

#https_trigger ⇒ Google::Apis::CloudfunctionsV1::HttpsTrigger

Describes HttpsTrigger, could be used to connect web hooks to function. Corresponds to the JSON property httpsTrigger

Returns:



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

def https_trigger
  @https_trigger
end

#labels ⇒ Hash<String,String>

Labels associated with this Cloud Function. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


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

def labels
  @labels
end

#name ⇒ String

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/* Corresponds to the JSON property name

Returns:

  • (String) 


123
124
125
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 123

def name
  @name
end

#service_account_email ⇒ String

Output only. The email of the function's service account. Corresponds to the JSON property serviceAccountEmail

Returns:

  • (String) 


128
129
130
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 128

def 
  @service_account_email
end

#source_archive_url ⇒ String

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. Corresponds to the JSON property sourceArchiveUrl

Returns:

  • (String) 


134
135
136
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 134

def source_archive_url
  @source_archive_url
end

#source_repository ⇒ Google::Apis::CloudfunctionsV1::SourceRepository

Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. Corresponds to the JSON property sourceRepository

Returns:



140
141
142
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 140

def source_repository
  @source_repository
end

#source_upload_url ⇒ String

The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl Corresponds to the JSON property sourceUploadUrl

Returns:

  • (String) 


146
147
148
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 146

def source_upload_url
  @source_upload_url
end

#status ⇒ String

Output only. Status of the function deployment. Corresponds to the JSON property status

Returns:

  • (String) 


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

def status
  @status
end

#timeout ⇒ String

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. Corresponds to the JSON property timeout

Returns:

  • (String) 


158
159
160
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 158

def timeout
  @timeout
end

#update_time ⇒ String

Output only. The last update timestamp of a Cloud Function. Corresponds to the JSON property updateTime

Returns:

  • (String) 


163
164
165
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 163

def update_time
  @update_time
end

#version_id ⇒ Fixnum

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. Corresponds to the JSON property versionId

Returns:

  • (Fixnum) 


170
171
172
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 170

def version_id
  @version_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 177

def update!(**args)
  @available_memory_mb = args[:available_memory_mb] if args.key?(:available_memory_mb)
  @description = args[:description] if args.key?(:description)
  @entry_point = args[:entry_point] if args.key?(:entry_point)
  @event_trigger = args[:event_trigger] if args.key?(:event_trigger)
  @https_trigger = args[:https_trigger] if args.key?(:https_trigger)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @source_archive_url = args[:source_archive_url] if args.key?(:source_archive_url)
  @source_repository = args[:source_repository] if args.key?(:source_repository)
  @source_upload_url = args[:source_upload_url] if args.key?(:source_upload_url)
  @status = args[:status] if args.key?(:status)
  @timeout = args[:timeout] if args.key?(:timeout)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version_id = args[:version_id] if args.key?(:version_id)
end