Package com.google.cloud.resourcemanager.v3

Class Project

  • All Implemented Interfaces:
    ProjectOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Project
extends com.google.protobuf.GeneratedMessageV3
implements ProjectOrBuilder
     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.
    Protobuf type google.cloud.resourcemanager.v3.Project
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

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

 Example: `projects/415104041262`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ProjectOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The unique resource name of the project. It is an int64
 generated number prefixed by "projects/".

 Example: `projects/415104041262`
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ProjectOrBuilder
        Returns:
        The bytes for name.

      • getParent

        public String getParent()
         Optional. A reference to a parent Resource. eg., `organizations/123` or
 `folders/876`.
        string parent = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getParent in interface ProjectOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Optional. A reference to a parent Resource. eg., `organizations/123` or
 `folders/876`.
        string parent = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getParentBytes in interface ProjectOrBuilder
        Returns:
        The bytes for parent.

      • getProjectId

        public String getProjectId()
         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`
        string project_id = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getProjectId in interface ProjectOrBuilder
        Returns:
        The projectId.

      • getProjectIdBytes

        public com.google.protobuf.ByteString getProjectIdBytes()
         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`
        string project_id = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getProjectIdBytes in interface ProjectOrBuilder
        Returns:
        The bytes for projectId.

      • getStateValue

        public int getStateValue()
         Output only. The project lifecycle state.
        .google.cloud.resourcemanager.v3.Project.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface ProjectOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Project.State getState()
         Output only. The project lifecycle state.
        .google.cloud.resourcemanager.v3.Project.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface ProjectOrBuilder
        Returns:
        The state.

      • getDisplayName

        public String getDisplayName()
         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`
        string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayName in interface ProjectOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         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`
        string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayNameBytes in interface ProjectOrBuilder
        Returns:
        The bytes for displayName.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ProjectOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ProjectOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Creation time.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ProjectOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The most recent time this resource was modified.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface ProjectOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The most recent time this resource was modified.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ProjectOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The most recent time this resource was modified.
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ProjectOrBuilder

      • hasDeleteTime

        public boolean hasDeleteTime()
         Output only. The time at which this resource was requested for deletion.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDeleteTime in interface ProjectOrBuilder
        Returns:
        Whether the deleteTime field is set.

      • getDeleteTime

        public com.google.protobuf.Timestamp getDeleteTime()
         Output only. The time at which this resource was requested for deletion.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTime in interface ProjectOrBuilder
        Returns:
        The deleteTime.

      • getDeleteTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. The time at which this resource was requested for deletion.
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTimeOrBuilder in interface ProjectOrBuilder

      • getEtag

        public String getEtag()
         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.
        string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEtag in interface ProjectOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         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.
        string etag = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getEtagBytes in interface ProjectOrBuilder
        Returns:
        The bytes for etag.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ProjectOrBuilder
         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"`
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface ProjectOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         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"`
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface ProjectOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         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"`
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface ProjectOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         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"`
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface ProjectOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         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"`
        map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface ProjectOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Project parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Project parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Project parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Project parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Project parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Project parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Project parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Project.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Project.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Project.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Project getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Project> parser()

      • getParserForType

        public com.google.protobuf.Parser<Project> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Project getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder