- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.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.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public final class FirewallPolicy extends GeneratedMessageV3 implements FirewallPolicyOrBuilderRepresents a Firewall Policy resource.
Protobuf type google.cloud.compute.v1.FirewallPolicy
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FirewallPolicyImplements
FirewallPolicyOrBuilderStatic Fields
ASSOCIATIONS_FIELD_NUMBER
public static final int ASSOCIATIONS_FIELD_NUMBER| Type | Description |
| int |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER| Type | Description |
| int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER| Type | Description |
| int |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER| Type | Description |
| int |
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER| Type | Description |
| int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER| Type | Description |
| int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER| Type | Description |
| int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Type | Description |
| int |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER| Type | Description |
| int |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER| Type | Description |
| int |
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER| Type | Description |
| int |
RULE_TUPLE_COUNT_FIELD_NUMBER
public static final int RULE_TUPLE_COUNT_FIELD_NUMBER| Type | Description |
| int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER| Type | Description |
| int |
SELF_LINK_WITH_ID_FIELD_NUMBER
public static final int SELF_LINK_WITH_ID_FIELD_NUMBER| Type | Description |
| int |
SHORT_NAME_FIELD_NUMBER
public static final int SHORT_NAME_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static FirewallPolicy getDefaultInstance()| Type | Description |
| FirewallPolicy |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static FirewallPolicy.Builder newBuilder()| Type | Description |
| FirewallPolicy.Builder |
newBuilder(FirewallPolicy prototype)
public static FirewallPolicy.Builder newBuilder(FirewallPolicy prototype)| Name | Description |
| prototype | FirewallPolicy |
| Type | Description |
| FirewallPolicy.Builder |
parseDelimitedFrom(InputStream input)
public static FirewallPolicy parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static FirewallPolicy parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static FirewallPolicy parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static FirewallPolicy parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static FirewallPolicy parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static FirewallPolicy parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FirewallPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| FirewallPolicy |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<FirewallPolicy> parser()| Type | Description |
| Parser<FirewallPolicy> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getAssociations(int index)
public FirewallPolicyAssociation getAssociations(int index)A list of associations that belong to this firewall policy.
repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;
| Name | Description |
| index | int |
| Type | Description |
| FirewallPolicyAssociation |
getAssociationsCount()
public int getAssociationsCount()A list of associations that belong to this firewall policy.
repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;
| Type | Description |
| int |
getAssociationsList()
public List<FirewallPolicyAssociation> getAssociationsList()A list of associations that belong to this firewall policy.
repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;
| Type | Description |
| List<FirewallPolicyAssociation> |
getAssociationsOrBuilder(int index)
public FirewallPolicyAssociationOrBuilder getAssociationsOrBuilder(int index)A list of associations that belong to this firewall policy.
repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;
| Name | Description |
| index | int |
| Type | Description |
| FirewallPolicyAssociationOrBuilder |
getAssociationsOrBuilderList()
public List<? extends FirewallPolicyAssociationOrBuilder> getAssociationsOrBuilderList()A list of associations that belong to this firewall policy.
repeated .google.cloud.compute.v1.FirewallPolicyAssociation associations = 508736530;
| Type | Description |
| List<? extends com.google.cloud.compute.v1.FirewallPolicyAssociationOrBuilder> |
getCreationTimestamp()
public String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public FirewallPolicy getDefaultInstanceForType()| Type | Description |
| FirewallPolicy |
getDescription()
public String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| ByteString | The bytes for description. |
getDisplayName()
public 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;
| Type | Description |
| String | The displayName. |
getDisplayNameBytes()
public 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;
| Type | Description |
| ByteString | The bytes for displayName. |
getFingerprint()
public 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;
| Type | Description |
| String | The fingerprint. |
getFingerprintBytes()
public 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;
| Type | Description |
| ByteString | The bytes for fingerprint. |
getId()
public long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| long | The id. |
getKind()
public String getKind()[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
optional string kind = 3292052;
| Type | Description |
| String | The kind. |
getKindBytes()
public ByteString getKindBytes()[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
optional string kind = 3292052;
| Type | Description |
| ByteString | The bytes for kind. |
getName()
public String getName()Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by GCP which uniquely identifies the Organization Firewall Policy.
optional string name = 3373707;
| Type | Description |
| String | The name. |
getNameBytes()
public ByteString getNameBytes()Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by GCP which uniquely identifies the Organization Firewall Policy.
optional string name = 3373707;
| Type | Description |
| ByteString | The bytes for name. |
getParent()
public String getParent()[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
optional string parent = 78317738;
| Type | Description |
| String | The parent. |
getParentBytes()
public ByteString getParentBytes()[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
optional string parent = 78317738;
| Type | Description |
| ByteString | The bytes for parent. |
getParserForType()
public Parser<FirewallPolicy> getParserForType()| Type | Description |
| Parser<FirewallPolicy> |
getRegion()
public 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;
| Type | Description |
| String | The region. |
getRegionBytes()
public 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;
| Type | Description |
| ByteString | The bytes for region. |
getRuleTupleCount()
public 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;
| Type | Description |
| int | The ruleTupleCount. |
getRules(int index)
public 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;
| Name | Description |
| index | int |
| Type | Description |
| FirewallPolicyRule |
getRulesCount()
public 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;
| Type | Description |
| int |
getRulesList()
public 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;
| Type | Description |
| List<FirewallPolicyRule> |
getRulesOrBuilder(int index)
public 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;
| Name | Description |
| index | int |
| Type | Description |
| FirewallPolicyRuleOrBuilder |
getRulesOrBuilderList()
public 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;
| Type | Description |
| List<? extends com.google.cloud.compute.v1.FirewallPolicyRuleOrBuilder> |
getSelfLink()
public String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| ByteString | The bytes for selfLink. |
getSelfLinkWithId()
public String getSelfLinkWithId()[Output Only] Server-defined URL for this resource with the resource id.
optional string self_link_with_id = 44520962;
| Type | Description |
| String | The selfLinkWithId. |
getSelfLinkWithIdBytes()
public ByteString getSelfLinkWithIdBytes()[Output Only] Server-defined URL for this resource with the resource id.
optional string self_link_with_id = 44520962;
| Type | Description |
| ByteString | The bytes for selfLinkWithId. |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getShortName()
public 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;
| Type | Description |
| String | The shortName. |
getShortNameBytes()
public 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;
| Type | Description |
| ByteString | The bytes for shortName. |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hasCreationTimestamp()
public boolean hasCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| boolean | Whether the creationTimestamp field is set. |
hasDescription()
public boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| boolean | Whether the description field is set. |
hasDisplayName()
public 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;
| Type | Description |
| boolean | Whether the displayName field is set. |
hasFingerprint()
public 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;
| Type | Description |
| boolean | Whether the fingerprint field is set. |
hasId()
public boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| boolean | Whether the id field is set. |
hasKind()
public boolean hasKind()[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
optional string kind = 3292052;
| Type | Description |
| boolean | Whether the kind field is set. |
hasName()
public boolean hasName()Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by GCP which uniquely identifies the Organization Firewall Policy.
optional string name = 3373707;
| Type | Description |
| boolean | Whether the name field is set. |
hasParent()
public boolean hasParent()[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
optional string parent = 78317738;
| Type | Description |
| boolean | Whether the parent field is set. |
hasRegion()
public 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;
| Type | Description |
| boolean | Whether the region field is set. |
hasRuleTupleCount()
public 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;
| Type | Description |
| boolean | Whether the ruleTupleCount field is set. |
hasSelfLink()
public boolean hasSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| boolean | Whether the selfLink field is set. |
hasSelfLinkWithId()
public boolean hasSelfLinkWithId()[Output Only] Server-defined URL for this resource with the resource id.
optional string self_link_with_id = 44520962;
| Type | Description |
| boolean | Whether the selfLinkWithId field is set. |
hasShortName()
public 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;
| Type | Description |
| boolean | Whether the shortName field is set. |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public FirewallPolicy.Builder newBuilderForType()| Type | Description |
| FirewallPolicy.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FirewallPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| FirewallPolicy.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public FirewallPolicy.Builder toBuilder()| Type | Description |
| FirewallPolicy.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |