Class: Google::Iam::V1beta::WorkloadIdentityPool

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/iam/v1beta/workload_identity_pool.rb

Overview

Represents a collection of external workload identities. You can define IAM policies to grant these identities access to Google Cloud resources.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns A description of the pool. Cannot exceed 256 characters.

Returns:

  • (::String) —

    A description of the pool. Cannot exceed 256 characters.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 42

class WorkloadIdentityPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current state of the pool.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The pool is active, and may be used in Google Cloud policies.
    ACTIVE = 1

    # The pool is soft-deleted. Soft-deleted pools are permanently deleted
    # after approximately 30 days. You can restore a soft-deleted pool using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool UndeleteWorkloadIdentityPool}.
    #
    # You cannot reuse the ID of a soft-deleted pool until it is permanently
    # deleted.
    #
    # While a pool is deleted, you cannot use it to exchange tokens, or use
    # existing tokens to access resources. If the pool is undeleted, existing
    # tokens grant access again.
    DELETED = 2
  end
end

#disabled ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 42

class WorkloadIdentityPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current state of the pool.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The pool is active, and may be used in Google Cloud policies.
    ACTIVE = 1

    # The pool is soft-deleted. Soft-deleted pools are permanently deleted
    # after approximately 30 days. You can restore a soft-deleted pool using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool UndeleteWorkloadIdentityPool}.
    #
    # You cannot reuse the ID of a soft-deleted pool until it is permanently
    # deleted.
    #
    # While a pool is deleted, you cannot use it to exchange tokens, or use
    # existing tokens to access resources. If the pool is undeleted, existing
    # tokens grant access again.
    DELETED = 2
  end
end

#display_name ⇒ ::String

Returns A display name for the pool. Cannot exceed 32 characters.

Returns:

  • (::String) —

    A display name for the pool. Cannot exceed 32 characters.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 42

class WorkloadIdentityPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current state of the pool.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The pool is active, and may be used in Google Cloud policies.
    ACTIVE = 1

    # The pool is soft-deleted. Soft-deleted pools are permanently deleted
    # after approximately 30 days. You can restore a soft-deleted pool using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool UndeleteWorkloadIdentityPool}.
    #
    # You cannot reuse the ID of a soft-deleted pool until it is permanently
    # deleted.
    #
    # While a pool is deleted, you cannot use it to exchange tokens, or use
    # existing tokens to access resources. If the pool is undeleted, existing
    # tokens grant access again.
    DELETED = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the pool.

Returns:

  • (::String) —

    Output only. The resource name of the pool.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 42

class WorkloadIdentityPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current state of the pool.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The pool is active, and may be used in Google Cloud policies.
    ACTIVE = 1

    # The pool is soft-deleted. Soft-deleted pools are permanently deleted
    # after approximately 30 days. You can restore a soft-deleted pool using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool UndeleteWorkloadIdentityPool}.
    #
    # You cannot reuse the ID of a soft-deleted pool until it is permanently
    # deleted.
    #
    # While a pool is deleted, you cannot use it to exchange tokens, or use
    # existing tokens to access resources. If the pool is undeleted, existing
    # tokens grant access again.
    DELETED = 2
  end
end

#state ⇒ ::Google::Iam::V1beta::WorkloadIdentityPool::State (readonly)

Returns Output only. The state of the pool.

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'proto_docs/google/iam/v1beta/workload_identity_pool.rb', line 42

class WorkloadIdentityPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current state of the pool.
  module State
    # State unspecified.
    STATE_UNSPECIFIED = 0

    # The pool is active, and may be used in Google Cloud policies.
    ACTIVE = 1

    # The pool is soft-deleted. Soft-deleted pools are permanently deleted
    # after approximately 30 days. You can restore a soft-deleted pool using
    # {::Google::Iam::V1beta::WorkloadIdentityPools::Client#undelete_workload_identity_pool UndeleteWorkloadIdentityPool}.
    #
    # You cannot reuse the ID of a soft-deleted pool until it is permanently
    # deleted.
    #
    # While a pool is deleted, you cannot use it to exchange tokens, or use
    # existing tokens to access resources. If the pool is undeleted, existing
    # tokens grant access again.
    DELETED = 2
  end
end