Class: Google::Apis::CloudfunctionsV1beta2::CloudFunction

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudfunctions_v1beta2/classes.rb,
generated/google/apis/cloudfunctions_v1beta2/representations.rb,
generated/google/apis/cloudfunctions_v1beta2/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



190
191
192
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 190

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_v1beta2/classes.rb', line 86

def available_memory_mb
  @available_memory_mb
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) 


96
97
98
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 96

def entry_point
  @entry_point
end

#event_trigger ⇒ Google::Apis::CloudfunctionsV1beta2::EventTrigger

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

Returns:



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

def event_trigger
  @event_trigger
end

#https_trigger ⇒ Google::Apis::CloudfunctionsV1beta2::HttpsTrigger

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

Returns:



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

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>) 


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

def labels
  @labels
end

#latest_operation ⇒ String

Output only. Name of the most recent operation modifying the function. If the function status is DEPLOYING or DELETING, then it points to the active operation. Corresponds to the JSON property latestOperation

Returns:

  • (String) 


119
120
121
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 119

def latest_operation
  @latest_operation
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) 


125
126
127
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 125

def name
  @name
end

#service_account ⇒ String

Output only. The service account of the function. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


130
131
132
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 130

def 
  @service_account
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) 


136
137
138
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 136

def source_archive_url
  @source_archive_url
end

#source_repository ⇒ Google::Apis::CloudfunctionsV1beta2::SourceRepository

Describes the location of the function source in a remote repository. Corresponds to the JSON property sourceRepository

Returns:



141
142
143
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 141

def source_repository
  @source_repository
end

#source_repository_url ⇒ String

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/ paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/ * You may omit paths/* if you want to use the main directory. Corresponds to the JSON property sourceRepositoryUrl

Returns:

  • (String) 


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

def source_repository_url
  @source_repository_url
end

#source_upload_url ⇒ String

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

Returns:

  • (String) 


164
165
166
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 164

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) 


169
170
171
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 169

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) 


176
177
178
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 176

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) 


181
182
183
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 181

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) 


188
189
190
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 188

def version_id
  @version_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'generated/google/apis/cloudfunctions_v1beta2/classes.rb', line 195

def update!(**args)
  @available_memory_mb = args[:available_memory_mb] if args.key?(:available_memory_mb)
  @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)
  @latest_operation = args[:latest_operation] if args.key?(:latest_operation)
  @name = args[:name] if args.key?(:name)
  @service_account = args[:service_account] if args.key?(:service_account)
  @source_archive_url = args[:source_archive_url] if args.key?(:source_archive_url)
  @source_repository = args[:source_repository] if args.key?(:source_repository)
  @source_repository_url = args[:source_repository_url] if args.key?(:source_repository_url)
  @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