com.google.cloud.resourcemanager.v3.ProjectOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-resourcemanager-v3 Show documentation
Show all versions of proto-google-cloud-resourcemanager-v3 Show documentation
Proto library for google-cloud-resourcemanager
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/resourcemanager/v3/projects.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.resourcemanager.v3;
public interface ProjectOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.resourcemanager.v3.Project)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Optional. A reference to a parent Resource. eg., `organizations/123` or
* `folders/876`.
*
*
* string parent = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The parent.
*/
java.lang.String getParent();
/**
*
*
*
* Optional. A reference to a parent Resource. eg., `organizations/123` or
* `folders/876`.
*
*
* string parent = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* 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];
*
* @return The projectId.
*/
java.lang.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];
*
* @return The bytes for projectId.
*/
com.google.protobuf.ByteString getProjectIdBytes();
/**
*
*
*
* Output only. The project lifecycle state.
*
*
*
* .google.cloud.resourcemanager.v3.Project.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The project lifecycle state.
*
*
*
* .google.cloud.resourcemanager.v3.Project.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.resourcemanager.v3.Project.State getState();
/**
*
*
*
* 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];
*
* @return The displayName.
*/
java.lang.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];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Output only. Creation time.
*
*
* .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. Creation time.
*
*
* .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. Creation time.
*
*
* .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The most recent time this resource was modified.
*
*
* .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The most recent time this resource was modified.
*
*
* .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Output only. The time at which this resource was requested for deletion.
*
*
* .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the deleteTime field is set.
*/
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];
*
*
* @return The deleteTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder();
/**
*
*
*
* 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];
*
* @return The etag.
*/
java.lang.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];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* 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];
*/
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];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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];
*/
java.util.Map 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];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
}