Class Instance.Builder (0.11.0)

public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilder

A resource that represents a Secure Source Manager instance.

Protobuf type google.cloud.securesourcemanager.v1.Instance

Implements

InstanceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

build()

public Instance build()
Returns
TypeDescription
Instance

buildPartial()

public Instance buildPartial()
Returns
TypeDescription
Instance

clear()

public Instance.Builder clear()
Returns
TypeDescription
Instance.Builder
Overrides

clearCreateTime()

public Instance.Builder clearCreateTime()

Output only. Create timestamp.

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

Returns
TypeDescription
Instance.Builder

clearField(Descriptors.FieldDescriptor field)

public Instance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Instance.Builder
Overrides

clearHostConfig()

public Instance.Builder clearHostConfig()

Output only. A list of hostnames for this instance.

.google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.Builder

clearKmsKey()

public Instance.Builder clearKmsKey()

Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearLabels()

public Instance.Builder clearLabels()
Returns
TypeDescription
Instance.Builder

clearName()

public Instance.Builder clearName()

Optional. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id}

project_number: Maps to a unique int64 id assigned to each project.

location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions.

instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Instance.Builder
Overrides

clearState()

public Instance.Builder clearState()

Output only. Current state of the instance.

.google.cloud.securesourcemanager.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearStateNote()

public Instance.Builder clearStateNote()

Output only. An optional field providing information about the current instance state.

.google.cloud.securesourcemanager.v1.Instance.StateNote state_note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearUpdateTime()

public Instance.Builder clearUpdateTime()

Output only. Update timestamp.

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

Returns
TypeDescription
Instance.Builder

clone()

public Instance.Builder clone()
Returns
TypeDescription
Instance.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Create timestamp.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Create timestamp.

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create timestamp.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
Instance

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHostConfig()

public Instance.HostConfig getHostConfig()

Output only. A list of hostnames for this instance.

.google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.HostConfig

The hostConfig.

getHostConfigBuilder()

public Instance.HostConfig.Builder getHostConfigBuilder()

Output only. A list of hostnames for this instance.

.google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.HostConfig.Builder

getHostConfigOrBuilder()

public Instance.HostConfigOrBuilder getHostConfigOrBuilder()

Output only. A list of hostnames for this instance.

.google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.HostConfigOrBuilder

getKmsKey()

public String getKmsKey()

Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for kmsKey.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Optional. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id}

project_number: Maps to a unique int64 id assigned to each project.

location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions.

instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id}

project_number: Maps to a unique int64 id assigned to each project.

location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions.

instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for name.

getState()

public Instance.State getState()

Output only. Current state of the instance.

.google.cloud.securesourcemanager.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.State

The state.

getStateNote()

public Instance.StateNote getStateNote()

Output only. An optional field providing information about the current instance state.

.google.cloud.securesourcemanager.v1.Instance.StateNote state_note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Instance.StateNote

The stateNote.

getStateNoteValue()

public int getStateNoteValue()

Output only. An optional field providing information about the current instance state.

.google.cloud.securesourcemanager.v1.Instance.StateNote state_note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for stateNote.

getStateValue()

public int getStateValue()

Output only. Current state of the instance.

.google.cloud.securesourcemanager.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update timestamp.

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Update timestamp.

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

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update timestamp.

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

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Create timestamp.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasHostConfig()

public boolean hasHostConfig()

Output only. A list of hostnames for this instance.

.google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the hostConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update timestamp.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public Instance.Builder mergeCreateTime(Timestamp value)

Output only. Create timestamp.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Instance.Builder

mergeFrom(Instance other)

public Instance.Builder mergeFrom(Instance other)
Parameter
NameDescription
otherInstance
Returns
TypeDescription
Instance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Instance.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Instance.Builder
Overrides

mergeHostConfig(Instance.HostConfig value)

public Instance.Builder mergeHostConfig(Instance.HostConfig value)

Output only. A list of hostnames for this instance.

.google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueInstance.HostConfig
Returns
TypeDescription
Instance.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Instance.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Instance.Builder mergeUpdateTime(Timestamp value)

Output only. Update timestamp.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Instance.Builder

putAllLabels(Map<String,String> values)

public Instance.Builder putAllLabels(Map<String,String> values)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Instance.Builder

putLabels(String key, String value)

public Instance.Builder putLabels(String key, String value)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Instance.Builder

removeLabels(String key)

public Instance.Builder removeLabels(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
Instance.Builder

setCreateTime(Timestamp value)

public Instance.Builder setCreateTime(Timestamp value)

Output only. Create timestamp.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Instance.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Instance.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Create timestamp.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Instance.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

setHostConfig(Instance.HostConfig value)

public Instance.Builder setHostConfig(Instance.HostConfig value)

Output only. A list of hostnames for this instance.

.google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueInstance.HostConfig
Returns
TypeDescription
Instance.Builder

setHostConfig(Instance.HostConfig.Builder builderForValue)

public Instance.Builder setHostConfig(Instance.HostConfig.Builder builderForValue)

Output only. A list of hostnames for this instance.

.google.cloud.securesourcemanager.v1.Instance.HostConfig host_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueInstance.HostConfig.Builder
Returns
TypeDescription
Instance.Builder

setKmsKey(String value)

public Instance.Builder setKmsKey(String value)

Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The kmsKey to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public Instance.Builder setKmsKeyBytes(ByteString value)

Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string kms_key = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for kmsKey to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setName(String value)

public Instance.Builder setName(String value)

Optional. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id}

project_number: Maps to a unique int64 id assigned to each project.

location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions.

instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Instance.Builder setNameBytes(ByteString value)

Optional. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id}

project_number: Maps to a unique int64 id assigned to each project.

location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions.

instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

setState(Instance.State value)

public Instance.Builder setState(Instance.State value)

Output only. Current state of the instance.

.google.cloud.securesourcemanager.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueInstance.State

The state to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setStateNote(Instance.StateNote value)

public Instance.Builder setStateNote(Instance.StateNote value)

Output only. An optional field providing information about the current instance state.

.google.cloud.securesourcemanager.v1.Instance.StateNote state_note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueInstance.StateNote

The stateNote to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setStateNoteValue(int value)

public Instance.Builder setStateNoteValue(int value)

Output only. An optional field providing information about the current instance state.

.google.cloud.securesourcemanager.v1.Instance.StateNote state_note = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for stateNote to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setStateValue(int value)

public Instance.Builder setStateValue(int value)

Output only. Current state of the instance.

.google.cloud.securesourcemanager.v1.Instance.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Instance.Builder
Overrides

setUpdateTime(Timestamp value)

public Instance.Builder setUpdateTime(Timestamp value)

Output only. Update timestamp.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Instance.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Instance.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Update timestamp.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Instance.Builder