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.



2054
2055
2056
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2054

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) 


1938
1939
1940
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1938

def all_traffic_on_latest_revision
  @all_traffic_on_latest_revision
end

#available_cpu ⇒ String

The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container# resourcerequirements Example: "1" indicates 1 vCPU Corresponds to the JSON property availableCpu

Returns:

  • (String) 


1947
1948
1949
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1947

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


1955
1956
1957
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1955

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


1960
1961
1962
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1960

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) 


1965
1966
1967
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1965

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) 


1976
1977
1978
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1976

def max_instance_count
  @max_instance_count
end

#max_instance_request_concurrency ⇒ Fixnum

Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1. Corresponds to the JSON property maxInstanceRequestConcurrency

Returns:

  • (Fixnum) 


1982
1983
1984
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1982

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


1993
1994
1995
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1993

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) 


1998
1999
2000
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1998

def revision
  @revision
end

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

Secret environment variables configuration. Corresponds to the JSON property secretEnvironmentVariables

Returns:



2003
2004
2005
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2003

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:



2008
2009
2010
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2008

def secret_volumes
  @secret_volumes
end

#security_level ⇒ String

Security level configure whether the function only accepts https. This configuration is only applicable to 1st Gen functions with Http trigger. By default https is optional for 1st Gen functions; 2nd Gen functions are https ONLY. Corresponds to the JSON property securityLevel

Returns:

  • (String) 


2016
2017
2018
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2016

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


2022
2023
2024
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2022

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) 


2028
2029
2030
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2028

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) 


2035
2036
2037
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2035

def timeout_seconds
  @timeout_seconds
end

#uri ⇒ String

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

Returns:

  • (String) 


2040
2041
2042
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2040

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) 


2046
2047
2048
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2046

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) 


2052
2053
2054
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2052

def vpc_connector_egress_settings
  @vpc_connector_egress_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 2059

def update!(**args)
  @all_traffic_on_latest_revision = args[:all_traffic_on_latest_revision] if args.key?(:all_traffic_on_latest_revision)
  @available_cpu = args[:available_cpu] if args.key?(:available_cpu)
  @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)
  @max_instance_request_concurrency = args[:max_instance_request_concurrency] if args.key?(:max_instance_request_concurrency)
  @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)
  @security_level = args[:security_level] if args.key?(:security_level)
  @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