Class: Google::Apis::IamV1::WorkforcePool

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

Overview

Represents a collection of external workforces. Provides namespaces for federated users that can be referenced in IAM policies.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkforcePool

Returns a new instance of WorkforcePool.



2308
2309
2310
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2308

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

Instance Attribute Details

#description ⇒ String

A user-specified description of the pool. Cannot exceed 256 characters. Corresponds to the JSON property description

Returns:

  • (String) 


2266
2267
2268
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2266

def description
  @description
end

#disabled ⇒ Boolean Also known as: disabled?

Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


2273
2274
2275
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2273

def disabled
  @disabled
end

#display_name ⇒ String

A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


2280
2281
2282
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2280

def display_name
  @display_name
end

#name ⇒ String

Output only. The resource name of the pool. Format: locations/location/ workforcePools/workforce_pool_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


2286
2287
2288
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2286

def name
  @name
end

#parent ⇒ String

Immutable. The resource name of the parent. Format: organizations/org-id`. Corresponds to the JSON propertyparent`

Returns:

  • (String) 


2291
2292
2293
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2291

def parent
  @parent
end

#session_duration ⇒ String

Duration that the Google Cloud access tokens, console sign-in sessions, and gcloud sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If session_duration is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the session_duration and the SessionNotOnOrAfter claim in the SAML assertion. Corresponds to the JSON property sessionDuration

Returns:

  • (String) 


2301
2302
2303
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2301

def session_duration
  @session_duration
end

#state ⇒ String

Output only. The state of the pool. Corresponds to the JSON property state

Returns:

  • (String) 


2306
2307
2308
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2306

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2313
2314
2315
2316
2317
2318
2319
2320
2321
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2313

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @disabled = args[:disabled] if args.key?(:disabled)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @session_duration = args[:session_duration] if args.key?(:session_duration)
  @state = args[:state] if args.key?(:state)
end