Interface FirewallPolicyOrBuilder (1.63.0)

public interface FirewallPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAssociations(int index)

public abstract FirewallPolicyAssociation getAssociations(int index)

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Parameter
Name Description
index int
Returns
Type Description
FirewallPolicyAssociation

getAssociationsCount()

public abstract int getAssociationsCount()

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Returns
Type Description
int

getAssociationsList()

public abstract List<FirewallPolicyAssociation> getAssociationsList()

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Returns
Type Description
List<FirewallPolicyAssociation>

getAssociationsOrBuilder(int index)

public abstract FirewallPolicyAssociationOrBuilder getAssociationsOrBuilder(int index)

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Parameter
Name Description
index int
Returns
Type Description
FirewallPolicyAssociationOrBuilder

getAssociationsOrBuilderList()

public abstract List<? extends FirewallPolicyAssociationOrBuilder> getAssociationsOrBuilderList()

A list of associations that belong to this firewall policy.

repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.FirewallPolicyAssociationOrBuilder>

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDescription()

public abstract String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string display_name = 4473832;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string display_name = 4473832;

Returns
Type Description
ByteString

The bytes for displayName.

getFingerprint()

public abstract String getFingerprint()

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.

optional string fingerprint = 234678500;

Returns
Type Description
String

The fingerprint.

getFingerprintBytes()

public abstract ByteString getFingerprintBytes()

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.

optional string fingerprint = 234678500;

Returns
Type Description
ByteString

The bytes for fingerprint.

getId()

public abstract long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public abstract String getKind()

[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public abstract String getName()

Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParent()

public abstract String getParent()

[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.

optional string parent = 78317738;

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.

optional string parent = 78317738;

Returns
Type Description
ByteString

The bytes for parent.

getRegion()

public abstract String getRegion()

[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public abstract ByteString getRegionBytes()

[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

getRuleTupleCount()

public abstract int getRuleTupleCount()

[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

optional int32 rule_tuple_count = 388342037;

Returns
Type Description
int

The ruleTupleCount.

getRules(int index)

public abstract FirewallPolicyRule getRules(int index)

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;

Parameter
Name Description
index int
Returns
Type Description
FirewallPolicyRule

getRulesCount()

public abstract int getRulesCount()

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;

Returns
Type Description
int

getRulesList()

public abstract List<FirewallPolicyRule> getRulesList()

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;

Returns
Type Description
List<FirewallPolicyRule>

getRulesOrBuilder(int index)

public abstract FirewallPolicyRuleOrBuilder getRulesOrBuilder(int index)

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;

Parameter
Name Description
index int
Returns
Type Description
FirewallPolicyRuleOrBuilder

getRulesOrBuilderList()

public abstract List<? extends FirewallPolicyRuleOrBuilder> getRulesOrBuilderList()

A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.

repeated .google.cloud.compute.v1.FirewallPolicyRule rules = 108873975;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.FirewallPolicyRuleOrBuilder>
public abstract String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSelfLinkWithId()

public abstract String getSelfLinkWithId()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public abstract ByteString getSelfLinkWithIdBytes()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
ByteString

The bytes for selfLinkWithId.

getShortName()

public abstract String getShortName()

User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string short_name = 492051566;

Returns
Type Description
String

The shortName.

getShortNameBytes()

public abstract ByteString getShortNameBytes()

User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string short_name = 492051566;

Returns
Type Description
ByteString

The bytes for shortName.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public abstract boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDisplayName()

public abstract boolean hasDisplayName()

Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string display_name = 4473832;

Returns
Type Description
boolean

Whether the displayName field is set.

hasFingerprint()

public abstract boolean hasFingerprint()

Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.

optional string fingerprint = 234678500;

Returns
Type Description
boolean

Whether the fingerprint field is set.

hasId()

public abstract boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public abstract boolean hasKind()

[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public abstract boolean hasName()

Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasParent()

public abstract boolean hasParent()

[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.

optional string parent = 78317738;

Returns
Type Description
boolean

Whether the parent field is set.

hasRegion()

public abstract boolean hasRegion()

[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

hasRuleTupleCount()

public abstract boolean hasRuleTupleCount()

[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.

optional int32 rule_tuple_count = 388342037;

Returns
Type Description
boolean

Whether the ruleTupleCount field is set.

public abstract boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSelfLinkWithId()

public abstract boolean hasSelfLinkWithId()

[Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
boolean

Whether the selfLinkWithId field is set.

hasShortName()

public abstract boolean hasShortName()

User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string short_name = 492051566;

Returns
Type Description
boolean

Whether the shortName field is set.