Class: Google::Apis::CloudfunctionsV2alpha::ServiceConfig

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



1943
1944
1945
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1943

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) 


1827
1828
1829
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1827

def all_traffic_on_latest_revision
  @all_traffic_on_latest_revision
end

#available_cpu ⇒ String

[Preview] 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) 


1836
1837
1838
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1836

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) 


1844
1845
1846
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1844

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


1849
1850
1851
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1849

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) 


1854
1855
1856
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1854

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) 


1865
1866
1867
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1865

def max_instance_count
  @max_instance_count
end

#max_instance_request_concurrency ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1871
1872
1873
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1871

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) 


1882
1883
1884
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1882

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) 


1887
1888
1889
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1887

def revision
  @revision
end

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

Secret environment variables configuration. Corresponds to the JSON property secretEnvironmentVariables

Returns:



1892
1893
1894
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1892

def secret_environment_variables
  @secret_environment_variables
end

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

Secret volumes configuration. Corresponds to the JSON property secretVolumes

Returns:



1897
1898
1899
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1897

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) 


1905
1906
1907
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1905

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) 


1911
1912
1913
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1911

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) 


1917
1918
1919
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1917

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) 


1924
1925
1926
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1924

def timeout_seconds
  @timeout_seconds
end

#uri ⇒ String

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

Returns:

  • (String) 


1929
1930
1931
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1929

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) 


1935
1936
1937
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1935

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) 


1941
1942
1943
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1941

def vpc_connector_egress_settings
  @vpc_connector_egress_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 1948

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