Class InterceptDeployment.Builder (0.94.0)

public static final class InterceptDeployment.Builder extends GeneratedMessage.Builder<InterceptDeployment.Builder> implements InterceptDeploymentOrBuilder

A deployment represents a zonal intercept backend ready to accept GENEVE-encapsulated traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global intercept service.

Protobuf type google.cloud.networksecurity.v1.InterceptDeployment

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public InterceptDeployment build()
Returns
Type Description
InterceptDeployment

buildPartial()

public InterceptDeployment buildPartial()
Returns
Type Description
InterceptDeployment

clear()

public InterceptDeployment.Builder clear()
Returns
Type Description
InterceptDeployment.Builder
Overrides

clearCreateTime()

public InterceptDeployment.Builder clearCreateTime()

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
InterceptDeployment.Builder

clearDescription()

public InterceptDeployment.Builder clearDescription()

Optional. User-provided description of the deployment. Used as additional context for the deployment.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

clearForwardingRule()

public InterceptDeployment.Builder clearForwardingRule()

Required. Immutable. The regional forwarding rule that fronts the interceptors, for example: projects/123456789/regions/us-central1/forwardingRules/my-rule. See https://google.aip.dev/124.

string forwarding_rule = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

clearInterceptDeploymentGroup()

public InterceptDeployment.Builder clearInterceptDeploymentGroup()

Required. Immutable. The deployment group that this deployment is a part of, for example: projects/123456789/locations/global/interceptDeploymentGroups/my-dg. See https://google.aip.dev/124.

string intercept_deployment_group = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

clearLabels()

public InterceptDeployment.Builder clearLabels()
Returns
Type Description
InterceptDeployment.Builder

clearName()

public InterceptDeployment.Builder clearName()

Immutable. Identifier. The resource name of this deployment, for example: projects/123456789/locations/us-central1-a/interceptDeployments/my-dep. See https://google.aip.dev/122 for more details.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

clearReconciling()

public InterceptDeployment.Builder clearReconciling()

Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.

bool reconciling = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

clearState()

public InterceptDeployment.Builder clearState()

Output only. The current state of the deployment. See https://google.aip.dev/216.

.google.cloud.networksecurity.v1.InterceptDeployment.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

clearUpdateTime()

public InterceptDeployment.Builder clearUpdateTime()

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
InterceptDeployment.Builder

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels are key/value pairs that help to organize and filter resources.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public InterceptDeployment getDefaultInstanceForType()
Returns
Type Description
InterceptDeployment

getDescription()

public String getDescription()

Optional. User-provided description of the deployment. Used as additional context for the deployment.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-provided description of the deployment. Used as additional context for the deployment.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getForwardingRule()

public String getForwardingRule()

Required. Immutable. The regional forwarding rule that fronts the interceptors, for example: projects/123456789/regions/us-central1/forwardingRules/my-rule. See https://google.aip.dev/124.

string forwarding_rule = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The forwardingRule.

getForwardingRuleBytes()

public ByteString getForwardingRuleBytes()

Required. Immutable. The regional forwarding rule that fronts the interceptors, for example: projects/123456789/regions/us-central1/forwardingRules/my-rule. See https://google.aip.dev/124.

string forwarding_rule = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for forwardingRule.

getInterceptDeploymentGroup()

public String getInterceptDeploymentGroup()

Required. Immutable. The deployment group that this deployment is a part of, for example: projects/123456789/locations/global/interceptDeploymentGroups/my-dg. See https://google.aip.dev/124.

string intercept_deployment_group = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The interceptDeploymentGroup.

getInterceptDeploymentGroupBytes()

public ByteString getInterceptDeploymentGroupBytes()

Required. Immutable. The deployment group that this deployment is a part of, for example: projects/123456789/locations/global/interceptDeploymentGroups/my-dg. See https://google.aip.dev/124.

string intercept_deployment_group = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for interceptDeploymentGroup.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels are key/value pairs that help to organize and filter resources.

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

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels are key/value pairs that help to organize and filter resources.

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels are key/value pairs that help to organize and filter resources.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels are key/value pairs that help to organize and filter resources.

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

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Immutable. Identifier. The resource name of this deployment, for example: projects/123456789/locations/us-central1-a/interceptDeployments/my-dep. See https://google.aip.dev/122 for more details.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. Identifier. The resource name of this deployment, for example: projects/123456789/locations/us-central1-a/interceptDeployments/my-dep. See https://google.aip.dev/122 for more details.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getReconciling()

public boolean getReconciling()

Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.

bool reconciling = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getState()

public InterceptDeployment.State getState()

Output only. The current state of the deployment. See https://google.aip.dev/216.

.google.cloud.networksecurity.v1.InterceptDeployment.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InterceptDeployment.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the deployment. See https://google.aip.dev/216.

.google.cloud.networksecurity.v1.InterceptDeployment.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public InterceptDeployment.Builder mergeCreateTime(Timestamp value)

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
InterceptDeployment.Builder

mergeFrom(InterceptDeployment other)

public InterceptDeployment.Builder mergeFrom(InterceptDeployment other)
Parameter
Name Description
other InterceptDeployment
Returns
Type Description
InterceptDeployment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InterceptDeployment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InterceptDeployment.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public InterceptDeployment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
InterceptDeployment.Builder
Overrides

mergeUpdateTime(Timestamp value)

public InterceptDeployment.Builder mergeUpdateTime(Timestamp value)

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
InterceptDeployment.Builder

putAllLabels(Map<String,String> values)

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

Optional. Labels are key/value pairs that help to organize and filter resources.

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

Parameter
Name Description
values Map<String,String>
Returns
Type Description
InterceptDeployment.Builder

putLabels(String key, String value)

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

Optional. Labels are key/value pairs that help to organize and filter resources.

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

Parameters
Name Description
key String
value String
Returns
Type Description
InterceptDeployment.Builder

removeLabels(String key)

public InterceptDeployment.Builder removeLabels(String key)

Optional. Labels are key/value pairs that help to organize and filter resources.

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

Parameter
Name Description
key String
Returns
Type Description
InterceptDeployment.Builder

setCreateTime(Timestamp value)

public InterceptDeployment.Builder setCreateTime(Timestamp value)

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
InterceptDeployment.Builder

setCreateTime(Timestamp.Builder builderForValue)

public InterceptDeployment.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
InterceptDeployment.Builder

setDescription(String value)

public InterceptDeployment.Builder setDescription(String value)

Optional. User-provided description of the deployment. Used as additional context for the deployment.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public InterceptDeployment.Builder setDescriptionBytes(ByteString value)

Optional. User-provided description of the deployment. Used as additional context for the deployment.

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setForwardingRule(String value)

public InterceptDeployment.Builder setForwardingRule(String value)

Required. Immutable. The regional forwarding rule that fronts the interceptors, for example: projects/123456789/regions/us-central1/forwardingRules/my-rule. See https://google.aip.dev/124.

string forwarding_rule = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The forwardingRule to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setForwardingRuleBytes(ByteString value)

public InterceptDeployment.Builder setForwardingRuleBytes(ByteString value)

Required. Immutable. The regional forwarding rule that fronts the interceptors, for example: projects/123456789/regions/us-central1/forwardingRules/my-rule. See https://google.aip.dev/124.

string forwarding_rule = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for forwardingRule to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setInterceptDeploymentGroup(String value)

public InterceptDeployment.Builder setInterceptDeploymentGroup(String value)

Required. Immutable. The deployment group that this deployment is a part of, for example: projects/123456789/locations/global/interceptDeploymentGroups/my-dg. See https://google.aip.dev/124.

string intercept_deployment_group = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The interceptDeploymentGroup to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setInterceptDeploymentGroupBytes(ByteString value)

public InterceptDeployment.Builder setInterceptDeploymentGroupBytes(ByteString value)

Required. Immutable. The deployment group that this deployment is a part of, for example: projects/123456789/locations/global/interceptDeploymentGroups/my-dg. See https://google.aip.dev/124.

string intercept_deployment_group = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for interceptDeploymentGroup to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setName(String value)

public InterceptDeployment.Builder setName(String value)

Immutable. Identifier. The resource name of this deployment, for example: projects/123456789/locations/us-central1-a/interceptDeployments/my-dep. See https://google.aip.dev/122 for more details.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public InterceptDeployment.Builder setNameBytes(ByteString value)

Immutable. Identifier. The resource name of this deployment, for example: projects/123456789/locations/us-central1-a/interceptDeployments/my-dep. See https://google.aip.dev/122 for more details.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setReconciling(boolean value)

public InterceptDeployment.Builder setReconciling(boolean value)

Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128.

bool reconciling = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The reconciling to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setState(InterceptDeployment.State value)

public InterceptDeployment.Builder setState(InterceptDeployment.State value)

Output only. The current state of the deployment. See https://google.aip.dev/216.

.google.cloud.networksecurity.v1.InterceptDeployment.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value InterceptDeployment.State

The state to set.

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setStateValue(int value)

public InterceptDeployment.Builder setStateValue(int value)

Output only. The current state of the deployment. See https://google.aip.dev/216.

.google.cloud.networksecurity.v1.InterceptDeployment.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

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

Returns
Type Description
InterceptDeployment.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public InterceptDeployment.Builder setUpdateTime(Timestamp value)

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
InterceptDeployment.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public InterceptDeployment.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
InterceptDeployment.Builder