Class: Google::Apis::RunV1::TrafficTarget

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

Overview

TrafficTarget holds a single entry of the routing table for a Route.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TrafficTarget

Returns a new instance of TrafficTarget.



2984
2985
2986
# File 'generated/google/apis/run_v1/classes.rb', line 2984

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

Instance Attribute Details

#configuration_nameString

ConfigurationName of a configuration to whose latest revision we will send this portion of traffic. When the "status.latestReadyRevisionName" of the referenced configuration changes, we will automatically migrate traffic from the prior "latest ready" revision to the new one. This field is never set in Route's status, only its spec. This is mutually exclusive with RevisionName. Cloud Run currently supports a single ConfigurationName. Corresponds to the JSON property configurationName

Returns:

  • (String)


2945
2946
2947
# File 'generated/google/apis/run_v1/classes.rb', line 2945

def configuration_name
  @configuration_name
end

#latest_revisionBoolean Also known as: latest_revision?

LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty. +optional Corresponds to the JSON property latestRevision

Returns:

  • (Boolean)


2953
2954
2955
# File 'generated/google/apis/run_v1/classes.rb', line 2953

def latest_revision
  @latest_revision
end

#percentFixnum

Percent specifies percent of the traffic to this Revision or Configuration. This defaults to zero if unspecified. Cloud Run currently requires 100 percent for a single ConfigurationName TrafficTarget entry. Corresponds to the JSON property percent

Returns:

  • (Fixnum)


2961
2962
2963
# File 'generated/google/apis/run_v1/classes.rb', line 2961

def percent
  @percent
end

#revision_nameString

RevisionName of a specific revision to which to send this portion of traffic. This is mutually exclusive with ConfigurationName. Providing RevisionName in spec is not currently supported by Cloud Run. Corresponds to the JSON property revisionName

Returns:

  • (String)


2968
2969
2970
# File 'generated/google/apis/run_v1/classes.rb', line 2968

def revision_name
  @revision_name
end

#tagString

Tag is optionally used to expose a dedicated url for referencing this target exclusively. +optional Corresponds to the JSON property tag

Returns:

  • (String)


2974
2975
2976
# File 'generated/google/apis/run_v1/classes.rb', line 2974

def tag
  @tag
end

#urlString

Output only. URL displays the URL for accessing tagged traffic targets. URL is displayed in status, and is disallowed on spec. URL must contain a scheme (e.g. http://) and a hostname, but may not contain anything else (e.g. basic auth, url path, etc. Not currently supported in Cloud Run. Corresponds to the JSON property url

Returns:

  • (String)


2982
2983
2984
# File 'generated/google/apis/run_v1/classes.rb', line 2982

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2989
2990
2991
2992
2993
2994
2995
2996
# File 'generated/google/apis/run_v1/classes.rb', line 2989

def update!(**args)
  @configuration_name = args[:configuration_name] if args.key?(:configuration_name)
  @latest_revision = args[:latest_revision] if args.key?(:latest_revision)
  @percent = args[:percent] if args.key?(:percent)
  @revision_name = args[:revision_name] if args.key?(:revision_name)
  @tag = args[:tag] if args.key?(:tag)
  @url = args[:url] if args.key?(:url)
end