- 1.57.0 (latest)
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.6
- 1.4.0
- 1.3.2
- 1.2.12
public static final class TagKey.Builder extends GeneratedMessageV3.Builder<TagKey.Builder> implements TagKeyOrBuilderA TagKey, used to group a set of TagValues.
Protobuf type google.cloud.resourcemanager.v3.TagKey
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TagKey.BuilderImplements
TagKeyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TagKey.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
build()
public TagKey build()| Returns | |
|---|---|
| Type | Description |
TagKey | |
buildPartial()
public TagKey buildPartial()| Returns | |
|---|---|
| Type | Description |
TagKey | |
clear()
public TagKey.Builder clear()| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
clearCreateTime()
public TagKey.Builder clearCreateTime()Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
clearDescription()
public TagKey.Builder clearDescription()Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
clearEtag()
public TagKey.Builder clearEtag()Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public TagKey.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
clearName()
public TagKey.Builder clearName() Immutable. The resource name for a TagKey. Must be in the format
tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for
the TagKey.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
clearNamespacedName()
public TagKey.Builder clearNamespacedName()Output only. Immutable. Namespaced name of the TagKey.
string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TagKey.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
clearParent()
public TagKey.Builder clearParent() Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form organizations/{org_id}. For
a TagKey parented by a Project, its parent can be in the form
projects/{project_id} or projects/{project_number}.
string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
clearPurpose()
public TagKey.Builder clearPurpose()Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines.
A purpose cannot be changed once set.
.google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
clearPurposeData()
public TagKey.Builder clearPurposeData()| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
clearShortName()
public TagKey.Builder clearShortName()Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.
The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
clearUpdateTime()
public TagKey.Builder clearUpdateTime()Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
clone()
public TagKey.Builder clone()| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
containsPurposeData(String key)
public boolean containsPurposeData(String key) Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose for formatting of this field.
Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getCreateTime()
public Timestamp getCreateTime()Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
getDefaultInstanceForType()
public TagKey getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TagKey | |
getDescription()
public String getDescription()Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getEtag()
public String getEtag()Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The etag. |
getEtagBytes()
public ByteString getEtagBytes()Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for etag. |
getMutablePurposeData() (deprecated)
public Map<String,String> getMutablePurposeData()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getName()
public String getName() Immutable. The resource name for a TagKey. Must be in the format
tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for
the TagKey.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes() Immutable. The resource name for a TagKey. Must be in the format
tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for
the TagKey.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getNamespacedName()
public String getNamespacedName()Output only. Immutable. Namespaced name of the TagKey.
string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String | The namespacedName. |
getNamespacedNameBytes()
public ByteString getNamespacedNameBytes()Output only. Immutable. Namespaced name of the TagKey.
string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for namespacedName. |
getParent()
public String getParent() Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form organizations/{org_id}. For
a TagKey parented by a Project, its parent can be in the form
projects/{project_id} or projects/{project_number}.
string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes() Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form organizations/{org_id}. For
a TagKey parented by a Project, its parent can be in the form
projects/{project_id} or projects/{project_number}.
string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for parent. |
getPurpose()
public Purpose getPurpose()Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines.
A purpose cannot be changed once set.
.google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Purpose | The purpose. |
getPurposeData() (deprecated)
public Map<String,String> getPurposeData()Use #getPurposeDataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getPurposeDataCount()
public int getPurposeDataCount() Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose for formatting of this field.
Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
getPurposeDataMap()
public Map<String,String> getPurposeDataMap() Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose for formatting of this field.
Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getPurposeDataOrDefault(String key, String defaultValue)
public String getPurposeDataOrDefault(String key, String defaultValue) Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose for formatting of this field.
Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getPurposeDataOrThrow(String key)
public String getPurposeDataOrThrow(String key) Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose for formatting of this field.
Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getPurposeValue()
public int getPurposeValue()Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines.
A purpose cannot be changed once set.
.google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for purpose. |
getShortName()
public String getShortName()Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.
The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String | The shortName. |
getShortNameBytes()
public ByteString getShortNameBytes()Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.
The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for shortName. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp | The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
hasCreateTime()
public boolean hasCreateTime()Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the createTime field is set. |
hasUpdateTime()
public boolean hasUpdateTime()Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeCreateTime(Timestamp value)
public TagKey.Builder mergeCreateTime(Timestamp value)Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
mergeFrom(TagKey other)
public TagKey.Builder mergeFrom(TagKey other)| Parameter | |
|---|---|
| Name | Description |
other | TagKey |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TagKey.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public TagKey.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TagKey.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
mergeUpdateTime(Timestamp value)
public TagKey.Builder mergeUpdateTime(Timestamp value)Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
putAllPurposeData(Map<String,String> values)
public TagKey.Builder putAllPurposeData(Map<String,String> values) Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose for formatting of this field.
Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
putPurposeData(String key, String value)
public TagKey.Builder putPurposeData(String key, String value) Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose for formatting of this field.
Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
removePurposeData(String key)
public TagKey.Builder removePurposeData(String key) Optional. Purpose data corresponds to the policy system that the tag is
intended for. See documentation for Purpose for formatting of this field.
Purpose data cannot be changed once set.
map<string, string> purpose_data = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
setCreateTime(Timestamp value)
public TagKey.Builder setCreateTime(Timestamp value)Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
setCreateTime(Timestamp.Builder builderForValue)
public TagKey.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Creation time.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
setDescription(String value)
public TagKey.Builder setDescription(String value)Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public TagKey.Builder setDescriptionBytes(ByteString value)Optional. User-assigned description of the TagKey. Must not exceed 256 characters.
Read-write.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setEtag(String value)
public TagKey.Builder setEtag(String value)Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe etag to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setEtagBytes(ByteString value)
public TagKey.Builder setEtagBytes(ByteString value)Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for etag to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public TagKey.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
setName(String value)
public TagKey.Builder setName(String value) Immutable. The resource name for a TagKey. Must be in the format
tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for
the TagKey.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public TagKey.Builder setNameBytes(ByteString value) Immutable. The resource name for a TagKey. Must be in the format
tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for
the TagKey.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setNamespacedName(String value)
public TagKey.Builder setNamespacedName(String value)Output only. Immutable. Namespaced name of the TagKey.
string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe namespacedName to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setNamespacedNameBytes(ByteString value)
public TagKey.Builder setNamespacedNameBytes(ByteString value)Output only. Immutable. Namespaced name of the TagKey.
string namespaced_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for namespacedName to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setParent(String value)
public TagKey.Builder setParent(String value) Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form organizations/{org_id}. For
a TagKey parented by a Project, its parent can be in the form
projects/{project_id} or projects/{project_number}.
string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public TagKey.Builder setParentBytes(ByteString value) Immutable. The resource name of the TagKey's parent. A TagKey can be
parented by an Organization or a Project. For a TagKey parented by an
Organization, its parent must be in the form organizations/{org_id}. For
a TagKey parented by a Project, its parent can be in the form
projects/{project_id} or projects/{project_number}.
string parent = 2 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setPurpose(Purpose value)
public TagKey.Builder setPurpose(Purpose value)Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines.
A purpose cannot be changed once set.
.google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | PurposeThe purpose to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setPurposeValue(int value)
public TagKey.Builder setPurposeValue(int value)Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines.
A purpose cannot be changed once set.
.google.cloud.resourcemanager.v3.Purpose purpose = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for purpose to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TagKey.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
setShortName(String value)
public TagKey.Builder setShortName(String value)Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.
The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe shortName to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setShortNameBytes(ByteString value)
public TagKey.Builder setShortNameBytes(ByteString value)Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.
The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
string short_name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for shortName to set. |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final TagKey.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
setUpdateTime(Timestamp value)
public TagKey.Builder setUpdateTime(Timestamp value)Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |
setUpdateTime(Timestamp.Builder builderForValue)
public TagKey.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Update time.
.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
TagKey.Builder | |