Class: Google::Cloud::ResourceManager::V3::Folder

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/resourcemanager/v3/folders.rb

Overview

A folder in an organization's resource hierarchy, used to organize that organization's resources.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Timestamp when the folder was created.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 64

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

  # Folder lifecycle states.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The folder has been marked for deletion by the user.
    DELETE_REQUESTED = 2
  end
end

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

Returns Output only. Timestamp when the folder was requested to be deleted.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 64

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

  # Folder lifecycle states.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The folder has been marked for deletion by the user.
    DELETE_REQUESTED = 2
  end
end

#display_name ⇒ ::String

Returns The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

Returns:

  • (::String) —

    The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 64

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

  # Folder lifecycle states.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The folder has been marked for deletion by the user.
    DELETE_REQUESTED = 2
  end
end

#etag ⇒ ::String (readonly)

Returns Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns:

  • (::String) —

    Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 64

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

  # Folder lifecycle states.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The folder has been marked for deletion by the user.
    DELETE_REQUESTED = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

Returns:

  • (::String) —

    Output only. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 64

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

  # Folder lifecycle states.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The folder has been marked for deletion by the user.
    DELETE_REQUESTED = 2
  end
end

#parent ⇒ ::String

Returns Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

Returns:

  • (::String) —

    Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 64

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

  # Folder lifecycle states.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The folder has been marked for deletion by the user.
    DELETE_REQUESTED = 2
  end
end

#state ⇒ ::Google::Cloud::ResourceManager::V3::Folder::State (readonly)

Returns Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 64

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

  # Folder lifecycle states.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The folder has been marked for deletion by the user.
    DELETE_REQUESTED = 2
  end
end

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

Returns Output only. Timestamp when the folder was last modified.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/resourcemanager/v3/folders.rb', line 64

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

  # Folder lifecycle states.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The folder has been marked for deletion by the user.
    DELETE_REQUESTED = 2
  end
end