Class: Google::Cloud::Firestore::Admin::V1::UserCreds

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/firestore/admin/v1/user_creds.rb

Overview

A Cloud Firestore User Creds.

Defined Under Namespace

Modules: State Classes: ResourceIdentity

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the user creds were created.

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/firestore/admin/v1/user_creds.rb', line 48

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

  # Describes a Resource Identity principal.
  # @!attribute [r] principal
  #   @return [::String]
  #     Output only. Principal identifier string.
  #     See: https://cloud.google.com/iam/docs/principal-identifiers
  class ResourceIdentity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the user creds (ENABLED or DISABLED).
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # The user creds are enabled.
    ENABLED = 1

    # The user creds are disabled.
    DISABLED = 2
  end
end

#name ⇒ ::String

Returns Identifier. The resource name of the UserCreds. Format: projects/{project}/databases/{database}/userCreds/{user_creds}.

Returns:

  • (::String) —

    Identifier. The resource name of the UserCreds. Format: projects/{project}/databases/{database}/userCreds/{user_creds}



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/firestore/admin/v1/user_creds.rb', line 48

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

  # Describes a Resource Identity principal.
  # @!attribute [r] principal
  #   @return [::String]
  #     Output only. Principal identifier string.
  #     See: https://cloud.google.com/iam/docs/principal-identifiers
  class ResourceIdentity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the user creds (ENABLED or DISABLED).
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # The user creds are enabled.
    ENABLED = 1

    # The user creds are disabled.
    DISABLED = 2
  end
end

#resource_identity ⇒ ::Google::Cloud::Firestore::Admin::V1::UserCreds::ResourceIdentity

Returns Resource Identity descriptor.

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/firestore/admin/v1/user_creds.rb', line 48

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

  # Describes a Resource Identity principal.
  # @!attribute [r] principal
  #   @return [::String]
  #     Output only. Principal identifier string.
  #     See: https://cloud.google.com/iam/docs/principal-identifiers
  class ResourceIdentity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the user creds (ENABLED or DISABLED).
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # The user creds are enabled.
    ENABLED = 1

    # The user creds are disabled.
    DISABLED = 2
  end
end

#secure_password ⇒ ::String (readonly)

Returns Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.

Returns:

  • (::String) —

    Output only. The plaintext server-generated password for the user creds. Only populated in responses for CreateUserCreds and ResetUserPassword.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/firestore/admin/v1/user_creds.rb', line 48

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

  # Describes a Resource Identity principal.
  # @!attribute [r] principal
  #   @return [::String]
  #     Output only. Principal identifier string.
  #     See: https://cloud.google.com/iam/docs/principal-identifiers
  class ResourceIdentity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the user creds (ENABLED or DISABLED).
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # The user creds are enabled.
    ENABLED = 1

    # The user creds are disabled.
    DISABLED = 2
  end
end

#state ⇒ ::Google::Cloud::Firestore::Admin::V1::UserCreds::State (readonly)

Returns Output only. Whether the user creds are enabled or disabled. Defaults to ENABLED on creation.

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/firestore/admin/v1/user_creds.rb', line 48

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

  # Describes a Resource Identity principal.
  # @!attribute [r] principal
  #   @return [::String]
  #     Output only. Principal identifier string.
  #     See: https://cloud.google.com/iam/docs/principal-identifiers
  class ResourceIdentity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the user creds (ENABLED or DISABLED).
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # The user creds are enabled.
    ENABLED = 1

    # The user creds are disabled.
    DISABLED = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the user creds were last updated.

Returns:



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'proto_docs/google/firestore/admin/v1/user_creds.rb', line 48

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

  # Describes a Resource Identity principal.
  # @!attribute [r] principal
  #   @return [::String]
  #     Output only. Principal identifier string.
  #     See: https://cloud.google.com/iam/docs/principal-identifiers
  class ResourceIdentity
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state of the user creds (ENABLED or DISABLED).
  module State
    # The default value. Should not be used.
    STATE_UNSPECIFIED = 0

    # The user creds are enabled.
    ENABLED = 1

    # The user creds are disabled.
    DISABLED = 2
  end
end