Class: Google::Cloud::ResourceManager::V3::Project

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

Overview

A project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. Creation time.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

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

Returns Output only. The time at which this resource was requested for deletion.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

#display_name ⇒ ::String

Returns Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.

Example: My Project.

Returns:

  • (::String) —

    Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.

    Example: My Project



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

#etag ⇒ ::String (readonly)

Returns Output only. A checksum computed by the server based on the current value of the Project 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 Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. The labels associated with this project.

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?.

Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?.

No more than 64 labels can be associated with a given resource.

Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed.

Example: "myBusinessDimension" : "businessValue".

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. The labels associated with this project.

    Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?.

    Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?.

    No more than 64 labels can be associated with a given resource.

    Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed.

    Example: "myBusinessDimension" : "businessValue"



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/".

Example: projects/415104041262.

Returns:

  • (::String) —

    Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/".

    Example: projects/415104041262



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

#parent ⇒ ::String

Returns Optional. A reference to a parent Resource. eg., organizations/123 or folders/876.

Returns:

  • (::String) —

    Optional. A reference to a parent Resource. eg., organizations/123 or folders/876.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

#project_id ⇒ ::String

Returns Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited.

Example: tokyo-rain-123.

Returns:

  • (::String) —

    Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited.

    Example: tokyo-rain-123



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

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

Returns Output only. The project lifecycle state.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end

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

Returns Output only. The most recent time this resource was modified.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 86

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Project lifecycle states.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 1

    # The project has been marked for deletion by the user
    # (by invoking
    # {::Google::Cloud::ResourceManager::V3::Projects::Client#delete_project DeleteProject})
    # or by the system (Google Cloud Platform).
    # This can generally be reversed by invoking [UndeleteProject]
    # [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
    DELETE_REQUESTED = 2
  end
end