com.google.cloud.resourcemanager.v3

Interface ProjectOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Project, Project.Builder

public interface ProjectOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
com.google.protobuf.Timestamp	getDeleteTime() Output only.
com.google.protobuf.TimestampOrBuilder	getDeleteTimeOrBuilder() Output only.
String	getDisplayName() Optional.
com.google.protobuf.ByteString	getDisplayNameBytes() Optional.
String	getEtag() Output only.
com.google.protobuf.ByteString	getEtagBytes() Output only.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getParent() Optional.
com.google.protobuf.ByteString	getParentBytes() Optional.
String	getProjectId() Immutable.
com.google.protobuf.ByteString	getProjectIdBytes() Immutable.
Project.State	getState() Output only.
int	getStateValue() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasDeleteTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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];

Returns:

The name.

getNameBytes

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];

Returns:

The bytes for name.

getParent

String getParent()

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

string parent = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The parent.

getParentBytes

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];

Returns:

The bytes for parent.

getProjectId

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];

Returns:

The projectId.

getProjectIdBytes

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];

Returns:

The bytes for projectId.

getStateValue

int getStateValue()

 Output only. The project lifecycle state.
 

.google.cloud.resourcemanager.v3.Project.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

Project.State getState()

 Output only. The project lifecycle state.
 

.google.cloud.resourcemanager.v3.Project.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

getDisplayName

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];

Returns:

The displayName.

getDisplayNameBytes

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];

Returns:

The bytes for displayName.

hasCreateTime

boolean hasCreateTime()

 Output only. Creation time.
 

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Creation time.
 

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Creation time.
 

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

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];

Returns:

The updateTime.

getUpdateTimeOrBuilder

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];

hasDeleteTime

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];

Returns:

Whether the deleteTime field is set.

getDeleteTime

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];

Returns:

The deleteTime.

getDeleteTimeOrBuilder

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];

getEtag

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];

Returns:

The etag.

getEtagBytes

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];

Returns:

The bytes for etag.

getLabelsCount

int getLabelsCount()

 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];

containsLabels

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];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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];

getLabelsOrDefault

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];

getLabelsOrThrow

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];