Class: Google::Apis::CloudfunctionsV2::ServiceConfig

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

Overview

Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ServiceConfig

Returns a new instance of ServiceConfig.



1725
1726
1727
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1725

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

Instance Attribute Details

#all_traffic_on_latest_revision ⇒ Boolean Also known as: all_traffic_on_latest_revision?

Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic. Corresponds to the JSON property allTrafficOnLatestRevision

Returns:

  • (Boolean) 


1631
1632
1633
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1631

def all_traffic_on_latest_revision
  @all_traffic_on_latest_revision
end

#available_memory ⇒ String

The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/ k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. Corresponds to the JSON property availableMemory

Returns:

  • (String) 


1640
1641
1642
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1640

def available_memory
  @available_memory
end

#environment_variables ⇒ Hash<String,String>

Environment variables that shall be available during function execution. Corresponds to the JSON property environmentVariables

Returns:

  • (Hash<String,String>) 


1645
1646
1647
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1645

def environment_variables
  @environment_variables
end

#ingress_settings ⇒ String

The ingress settings for the function, controlling what traffic can reach it. Corresponds to the JSON property ingressSettings

Returns:

  • (String) 


1650
1651
1652
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1650

def ingress_settings
  @ingress_settings
end

#max_instance_count ⇒ Fixnum

The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details. Corresponds to the JSON property maxInstanceCount

Returns:

  • (Fixnum) 


1661
1662
1663
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1661

def max_instance_count
  @max_instance_count
end

#min_instance_count ⇒ Fixnum

The limit on the minimum number of function instances that may coexist at a given time. Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case. Corresponds to the JSON property minInstanceCount

Returns:

  • (Fixnum) 


1672
1673
1674
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1672

def min_instance_count
  @min_instance_count
end

#revision ⇒ String

Output only. The name of service revision. Corresponds to the JSON property revision

Returns:

  • (String) 


1677
1678
1679
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1677

def revision
  @revision
end

#secret_environment_variables ⇒ Array<Google::Apis::CloudfunctionsV2::SecretEnvVar>

Secret environment variables configuration. Corresponds to the JSON property secretEnvironmentVariables

Returns:



1682
1683
1684
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1682

def secret_environment_variables
  @secret_environment_variables
end

#secret_volumes ⇒ Array<Google::Apis::CloudfunctionsV2::SecretVolume>

Secret volumes configuration. Corresponds to the JSON property secretVolumes

Returns:



1687
1688
1689
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1687

def secret_volumes
  @secret_volumes
end

#service ⇒ String

Output only. Name of the service associated with a Function. The format of this field is projects/project/locations/region/services/service` Corresponds to the JSON propertyservice`

Returns:

  • (String) 


1693
1694
1695
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1693

def service
  @service
end

#service_account_email ⇒ String

The email of the service's service account. If empty, defaults to ` project_number-compute@developer.gserviceaccount.com. Corresponds to the JSON propertyserviceAccountEmail`

Returns:

  • (String) 


1699
1700
1701
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1699

def 
  @service_account_email
end

#timeout_seconds ⇒ Fixnum

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 timeoutSeconds

Returns:

  • (Fixnum) 


1706
1707
1708
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1706

def timeout_seconds
  @timeout_seconds
end

#uri ⇒ String

Output only. URI of the Service deployed. Corresponds to the JSON property uri

Returns:

  • (String) 


1711
1712
1713
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1711

def uri
  @uri
end

#vpc_connector ⇒ String

The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*. Corresponds to the JSON property vpcConnector

Returns:

  • (String) 


1717
1718
1719
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1717

def vpc_connector
  @vpc_connector
end

#vpc_connector_egress_settings ⇒ String

The egress settings for the connector, controlling what traffic is diverted through it. Corresponds to the JSON property vpcConnectorEgressSettings

Returns:

  • (String) 


1723
1724
1725
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1723

def vpc_connector_egress_settings
  @vpc_connector_egress_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1730

def update!(**args)
  @all_traffic_on_latest_revision = args[:all_traffic_on_latest_revision] if args.key?(:all_traffic_on_latest_revision)
  @available_memory = args[:available_memory] if args.key?(:available_memory)
  @environment_variables = args[:environment_variables] if args.key?(:environment_variables)
  @ingress_settings = args[:ingress_settings] if args.key?(:ingress_settings)
  @max_instance_count = args[:max_instance_count] if args.key?(:max_instance_count)
  @min_instance_count = args[:min_instance_count] if args.key?(:min_instance_count)
  @revision = args[:revision] if args.key?(:revision)
  @secret_environment_variables = args[:secret_environment_variables] if args.key?(:secret_environment_variables)
  @secret_volumes = args[:secret_volumes] if args.key?(:secret_volumes)
  @service = args[:service] if args.key?(:service)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @timeout_seconds = args[:timeout_seconds] if args.key?(:timeout_seconds)
  @uri = args[:uri] if args.key?(:uri)
  @vpc_connector = args[:vpc_connector] if args.key?(:vpc_connector)
  @vpc_connector_egress_settings = args[:vpc_connector_egress_settings] if args.key?(:vpc_connector_egress_settings)
end