Class: Google::Apis::IamV1::WorkloadIdentityPool

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 workload identities. You can define IAM policies to grant these identities access to Google Cloud resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkloadIdentityPool

Returns a new instance of WorkloadIdentityPool.



2590
2591
2592
# File 'lib/google/apis/iam_v1/classes.rb', line 2590

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

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)


2560
2561
2562
# File 'lib/google/apis/iam_v1/classes.rb', line 2560

def description
  @description
end

#disabledBoolean Also known as: disabled?

Whether the pool is disabled. 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)


2567
2568
2569
# File 'lib/google/apis/iam_v1/classes.rb', line 2567

def disabled
  @disabled
end

#display_nameString

A display name for the pool. Cannot exceed 32 characters. Corresponds to the JSON property displayName

Returns:

  • (String)


2573
2574
2575
# File 'lib/google/apis/iam_v1/classes.rb', line 2573

def display_name
  @display_name
end

#identity_modeString

Immutable. The identity mode of the pool. Corresponds to the JSON property identityMode

Returns:

  • (String)


2578
2579
2580
# File 'lib/google/apis/iam_v1/classes.rb', line 2578

def identity_mode
  @identity_mode
end

#nameString

Output only. The resource name of the pool. Corresponds to the JSON property name

Returns:

  • (String)


2583
2584
2585
# File 'lib/google/apis/iam_v1/classes.rb', line 2583

def name
  @name
end

#stateString

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

Returns:

  • (String)


2588
2589
2590
# File 'lib/google/apis/iam_v1/classes.rb', line 2588

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2595
2596
2597
2598
2599
2600
2601
2602
# File 'lib/google/apis/iam_v1/classes.rb', line 2595

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)
  @identity_mode = args[:identity_mode] if args.key?(:identity_mode)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
end